Updated documentation, added dependencies for Smaragd.

This commit is contained in:
wackyideas 2022-11-21 20:05:34 +01:00
parent 15b8a1017f
commit 5ac286b2fd
4 changed files with 30 additions and 0 deletions

View file

@ -14,6 +14,7 @@
10. [Task Switcher](#task-switcher) 10. [Task Switcher](#task-switcher)
11. [Sounds](#sounds) 11. [Sounds](#sounds)
12. [Wine](#wine) 12. [Wine](#wine)
13. [Video Guide](#video-guide)
### Prerequisites <a name="preq"></a> ### Prerequisites <a name="preq"></a>
@ -211,6 +212,28 @@ To apply Smaragd, select it in ```System settings -> Appearance -> Window Decora
Any changes made to the theme will be nearly instant. The changes are applied as soon as the window is updated (resizing, maximizing/restoring the window). It is not recommended to edit the theme file by hand. Any changes made to the theme will be nearly instant. The changes are applied as soon as the window is updated (resizing, maximizing/restoring the window). It is not recommended to edit the theme file by hand.
#### Compiling instructions
Compiling on Arch Linux requires a few dependencies to be present on your system:
- cmake
- cairo
- glib2
- kdebase-runtime
- kdelibs 4.14.X
The last two dependencies are available as prebuilt packages in this repository. The package `kdebase-runtime` doesn't exist anymore for Arch, not even the AUR, and 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 I recommend against it as compiling the package takes very long, and as of right now, building the package seems impossible. Other distributions will likely be better in terms of offering legacy packages.
To compile Smaragd, do the following in the terminal:
1. `cd smaragd-0.1.1`
2. `mkdir build`
3. `cd build`
4. ```cmake -DCMAKE_INSTALL_PREFIX=`kf5-config --prefix` ..```
5. `make`
6. `sudo make install`
If compiling multiple times, only the last step is required. Steps 1-4. are for setting the environment up for the first time.
### Plasma widgets <a name="widgets"></a> ### Plasma widgets <a name="widgets"></a>
@ -424,3 +447,8 @@ After that, go through all elements in the "Item" list, and change the font ever
- Font: Segoe UI - Font: Segoe UI
- Size: 9pt - Size: 9pt
### Video Guide (Outdated but still useful)<a name="video-guide"></a>
Video created by Bleeplo:
[![Video guide](https://img.youtube.com/vi/QuiUwqHq-RU/0.jpg)](https://www.youtube.com/watch?v=QuiUwqHq-RU)

Binary file not shown.

View file

@ -71,6 +71,8 @@ Certain plasmoids featured here make use of non-standard SVG items that are only
Also, this project modifies certain system components of KDE Plasma which are not meant to be editable, and WILL be replaced if KDE Plasma is reinstalled or upgraded. **Modifying private system components can leave your desktop environment in a broken state**. Make sure to create backups before attempting to install this project. I am not responsible for broken KDE and/or Linux installs. Also, this project modifies certain system components of KDE Plasma which are not meant to be editable, and WILL be replaced if KDE Plasma is reinstalled or upgraded. **Modifying private system components can leave your desktop environment in a broken state**. Make sure to create backups before attempting to install this project. I am not responsible for broken KDE and/or Linux installs.
Due to the fact that this project is under development and depends on upstream for a lot of things, things are subject to change and will likely break with updates from KDE and other components of the Linux desktop. As such, they may affect components of this theme. Keep an eye out on the issue tracker for further details when things inevitably happen to break.
Feel free to take this theme pack and modify it for yourself or share it with others, and if Feel free to take this theme pack and modify it for yourself or share it with others, and if
there are any improvements to be made here, any and all effort would be greatly appreciated. there are any improvements to be made here, any and all effort would be greatly appreciated.