Deprecate Smaragd, add SDDM theme, updated INSTALL.md

DOCUMENTATION.md

@@ -15,7 +15,6 @@ language the component is written in (plasmoids, applications) or the standard t
 
 - **Themes**
     - [Plasma theme (Seven-Black)](./Documentation/Themes/Seven-Black.md)
-    - [Window decoration theme (Emerald/Smaragd)](./Documentation/Themes/Smaragd-Theme.md)
 - **Software**
     - Plasmoids
         - [System tray (org.kde.plasma.private.systemtray)](./Documentation/Software/Plasmoids/System-Tray.md)
@@ -23,7 +22,6 @@ language the component is written in (plasmoids, applications) or the standard t
         - [SevenStart (io.gitgud.wackyideas.SevenStart)](./Documentation/Software/Plasmoids/SevenStart.md)
         - [SevenTasks (io.gitgud.wackyideas.seventasks)](./Documentation/Software/Plasmoids/SevenTasks.md)
     - KWin
-        - [Smaragd](./Documentation/Software/KWin/Smaragd.md)
         - [Reflection effect](./Documentation/Software/KWin/Reflection.md)
 
 To keep the documentation condensed and to prevent redundancy, components that don't require documentation or are out of scope for this project (as in, documentation exists elsewhere) will not be documented here:
@@ -32,6 +30,7 @@ To keep the documentation condensed and to prevent redundancy, components that d
 - Show desktop (Aero) (io.gitgud.wackyideas.win7showdesktop)
 - Keyboard switcher (org.kde.plasma.keyboardlayout)
 - Look and Feel (Splash and Lock screen theme) (authui7)
+- KWin decoration theme (smod)
 - Plasma tooltip (DefaultToolTip.qml)
 - Wine theme (Windows Style Builder)
 - Color scheme ([KDE's docs](https://docs.kde.org/stable5/en/plasma-workspace/kcontrol/colors/index.html), [Video guide](https://www.youtube.com/watch?v=6VW--o7CEEA))
@@ -74,16 +73,18 @@ This is a list of components that are included in this project, as well as their
 |Win2-7            |Windows 7 theme for GTK2 applications. Adapted to work better with QGtkStyle.                                     |Y       |[Juandejesuss](https://www.gnome-look.org/p/1012465)|
 |Windows 7 Kvantum |Fixed certain padding and sizing issues, added more textures.                                                     |Y       |[DrGordBord](https://store.kde.org/p/1679903)|
 |WindowsIcons      |Windows 8.1 icon pack adapted to fit KDE better while also changing certain icons to their Windows 7 counterparts.|N       |[B00merang team](https://b00merang.weebly.com/icon-themes.html)|
+|SDDM theme |SDDM session login theme.|Y       |[Souris-2d07](https://gitgud.io/souris)|
+
 
 
 ### KWin
 
 |Name             |Description                                                                                                                   |Finished|Fork|
 |-----------------|------------------------------------------------------------------------------------------------------------------------------|--------|----|
-|Aero Emerald     |Custom, non-standard Emerald theme made to work with Smaragd Seven. Features caption buttons that match the default sizes for both 7 and Vista.                                                           |Y       |[nicu96](https://store.kde.org/p/1003826/), [Souris-2d07](https://gitgud.io/souris)|
-|Reflection Effect|Effect that renders a glassy texture under windows.                                        |N       |[KDE](https://invent.kde.org/plasma/kwin/-/tree/master/src/plugins/blur)|
-|Firefox Blur Region Fix|Effect that fixes Firefox's transparency and allows it to have proper blur and reflections.                                        |N       |N/A|
-|Smaragd Seven    |KWin decoration theme which uses Emerald themes as a basis, with some Aero specific changes and bugfixes. Lacks HiDPI support.|N       |[KDE](https://invent.kde.org/plasma/smaragd)|
+|Reflection Effect|KWin Effect that renders a glassy texture under windows.                                        |N       |[KDE](https://invent.kde.org/plasma/kwin/-/tree/master/src/plugins/blur)|
+|Firefox Blur Region Fix|KWin Effect that fixes Firefox's transparency and allows it to have proper blur and reflections.                                        |N       |N/A|
+|SMOD    |KWin decoration theme based on Breeze, has support for removing inner window borders to mimic Windows 7's extended borders feature.|N       |[Souris-2d07](https://gitgud.io/souris)|
+|SMOD Button glow    |KWin effect that provides proper caption button glow |Y       |[Souris-2d07](https://gitgud.io/souris)|
 |Thumbnail Seven  |KWin task switcher that mostly replicates the look and behavior of Windows 7's task switcher|N|[KDE](https://invent.kde.org/plasma/kwin/-/tree/master/src/tabbox/switchers/thumbnail_grid)|
 
 ### Miscellaneous
@@ -93,6 +94,12 @@ This is a list of components that are included in this project, as well as their
 |Authui7 |Aero themed login splash and lock screen.|Y       |[dominichayesferen](https://github.com/dominichayesferen)|
 |Install script |Installation script for AeroThemePlasma.|N       |N/A|
 
+### Deprecated
+
+|Name               |Description                     |Finished|Fork|
+|-------------------|--------------------------------|--------|----|
+|Smaragd Seven    |KWin decoration theme which uses Emerald themes as a basis, with some Aero specific changes and bugfixes. Lacks HiDPI support.|N       |[KDE](https://invent.kde.org/plasma/smaragd)|
+|Aero Emerald     |Custom, non-standard Emerald theme made to work with Smaragd Seven. Features caption buttons that match the default sizes for both 7 and Vista.                                                           |Y       |[nicu96](https://store.kde.org/p/1003826/), [Souris-2d07](https://gitgud.io/souris)|
 
 ## Components to be implemented <a name="todo"></a>
 
@@ -100,6 +107,5 @@ These components are listed from highest priority to lowest priority.
 
 - **Qt visual style to closely replicate the native Windows GUI appearance (Like QWindowsVistaStyle, or a fork of Kvantum)**
 - **Proper sound theme (upcoming in KDE Plasma 6)**
-- **SDDM Login theme**
 - **Better folder thumbnailer plugin**
 - **Plymouth theme(?)**

INSTALL.md

@@ -15,6 +15,7 @@
 1. [Task Switcher](#task-switcher)
 1. [Look and Feel](#look-and-feel)
 1. [Sounds](#sounds)
+1. [SDDM](#sddm)
 1. [Wine](#wine)
 1. [Terminal](#terminal)
 1. [Firefox](#firefox)
@@ -205,55 +206,25 @@ Note: Font rendering on Linux is [largely broken now](https://gitlab.gnome.org/G
 
 ### Window Manager <a name="wm"></a>
 
-To install the window decoration, move the file:
+The KWin decoration theme comes in two parts: The decoration theme itself and a KWin effect for the caption button glow effect. Both components can be found in the following directory:
 
 ```
-$ ./KWin/smaragd_bin/kwin_smaragd.so
+$ ./KWin/smod_kwin_theme/
 ```
 
-to:
+To compile the components, run the following: 
 
 ```
-# /usr/lib/qt/plugins/org.kde.kdecoration2/
-``` 
-
-The window decoration requires an Emerald theme to be present as well. To install the theme, move the following directory (If it doesn't appear, enable viewing hidden files):
-
-```
-$ ./KWin/.emerald/
-``` 
-
-to the home directory.
-
-Smaragd reads the theme from the ```theme``` subfolder and ```settings.ini``` config file. If you want to use the Vista-sized caption buttons, rename the ```themevista``` subfolder and ```settingsvista.ini``` into the aforementioned names.
-
-To apply the window decoration, go to ```System settings -> Appearance -> Window Decorations``` and select Smaragd. 
-
-#### Compiling instructions
-
-Compiling Smaragd on Arch Linux requires a few dependencies to be installed on the system:
-
-- cmake
-- cairo
-- glib2
-- kdebase-runtime
-- kdelibs 4.14.x
-
-The last two dependencies are provided in this repository as prebuilt Arch packages. The package `kdebase-runtime` doesn't exist anymore for Arch, not even the AUR, so the only place to find it outside of this repository is through [this](https://archive.org/details/archlinux_pkg_kdebase-runtime) link. The package `kdelibs` can be installed through the AUR, however it isn't recommended as compiling the package takes very long, and as of right now, building the package seems to fail. Distributions like Debian might be better in terms of offering legacy packages.
-
-To compile Smaragd from the terminal:
-
-```bash
-cd smaragd-0.1.1
-mkdir build #You can delete the build directory that already exists, or use a different name
-cd build
-cmake -DCMAKE_INSTALL_PREFIX=`kf5-config --prefix` ..
-make
-sudo make install
+$ sh build-decoration.sh
+$ sh install-decoration.sh
+$ sh build-effect.sh
+$ sh install-effect.sh
 ```
 
-If compiling multiple times, only the last step is required. Steps 1-4. are for setting the environment up for the first time. 
-To see the changes after compiling and setting Smaragd in the System Settings, simply restart KWin.
+Log out of the Plasma session or restart KWin, and go to ```System Settings -> Appearance -> Window Decorations``` and select SMOD. In the settings for SMOD, set the shadow size to small.
+
+To enable caption button glow, go to ```System Settings -> Desktop Effects``` and enable the SMOD Window Buttons effect. 
+
 
 ### Reflection Effect <a name="reflection"></a>
 
@@ -337,7 +308,7 @@ It is possible to toggle showing labels by toggling the "Show labels on taskbar
 This plasmoid doesn't require additional configuration after installation if other steps have been completed. If for some reason the font and size do not look appropriate, set them to the following: 
 
 - Font size px: 9
-- Font style: Segoe UI Light, bold
+- Font style: Segoe UI
 
 #### Desktop containment
 
@@ -462,6 +433,22 @@ notifications:
 |Battery Low, Peripheral Battery Low|```/usr/share/sounds/media_windows/Windows Battery Low.wav```     |
 |Battery Critical                   |```/usr/share/sounds/media_windows/Windows Battery Critical.wav```|
 
+### SDDM <a name="sddm"></a>
+
+To install the SDDM theme, move the following folder:
+
+```
+$ ./Plasma/SDDM/sddm-theme-smod
+```
+
+to: 
+
+```
+# /usr/share/sddm/themes/
+```
+
+Go to ```System Settings -> Login Screen (SDDM)``` and select SMOD. If the theme doesn't look right, click the 'Apply Plasma Settings...' button and apply the changes.
+
 ### Wine <a name="wine"></a>
 
 To install the msstyle for Wine applications, run ```winecfg```, and under the 'Desktop Integration' tab, click 'Install theme' and choose the following file:
@@ -503,7 +490,15 @@ cd ./KWin/kwin_fixblur/
 sh install.sh
 ```
 
-After it has been compiled, you can log out or restart Plasma and KWin, then go to ```System settings -> Workspace Behavior -> Desktop Effects``` and enable the effect.
+After it has been compiled, move the following folder: 
+
+```
+$ ./KWin/.ffblurfix
+```
+
+To the home directory.
+
+You can log out or restart Plasma and KWin, then go to ```System settings -> Workspace Behavior -> Desktop Effects``` and enable the effect.
 
 By default, this effect is enabled for Firefox. If you're using a different Firefox-based browser (Firefox ESR, Nightly, Floorp, Librewolf, etc.), then they need to be included in the config menu by adding their secondary window class name to the list.
 
@@ -513,10 +508,3 @@ For example, to apply the effect to both Firefox and Librewolf, the config's tex
 firefox;librewolf
 ```
 
-Additionally, this effect loads in an SVG file from the following directory: 
-
-```
-$ ~/.emerald/ffBlurRegion.svg
-```
-
-which should be there assuming the rest of the installation has been done.