update

docs/APPS.md

@@ -1,6 +1,6 @@
+# APPS
 
-<details>
+*non-exhaustive list*
-<summary>Click to show installed apps</summary>
 
 | Category       | Software      |
 |----------------|---------------|
@@ -31,6 +31,3 @@
 |                | neofetch      |
 |                | cava          |
 |                | ...           |
-
-</details>
-

docs/CONTRIBUTING.md

@@ -0,0 +1,10 @@
+# Contributing to Nixy
+
+Everybody is invited and welcome to contribute to Nixy. There is a lot to do... Check the `docs/TODO.md` file!
+
+The process is straight-forward.
+
+ - Read [How to get faster PR reviews](https://github.com/kubernetes/community/blob/master/contributors/guide/pull-requests.md#best-practices-for-faster-reviews) by Kubernetes (but skip step 0 and 1)
+ - Fork Nixy [git repository](https://github.com/anotherhadi/nixy).
+ - Write your changes (new theme, bug fixes, ...).
+ - Create a Pull Request against the main branch of Nixy.

docs/SCRIPTS.md

@@ -1,9 +1,6 @@
-## Scripts
+# Scripts
 
-### Nix/NixOs shortcuts
+## Nix/NixOs shortcuts
-
-<details>
-<summary>Click to expand</summary>
 
 - `nixy-edit`
 - `nixy-rebuild`
@@ -11,23 +8,13 @@
 - `nixy-gc` # garbage collection
 - `nixy-cb` # clean boot menu
 
-</details>
+## Brightness control
-
-### Brightness control
-
-<details>
-<summary>Click to expand</summary>
 
 - `brightness-up`
 - `brightness-down`
 - `brightness-change <up/down> <increment>`
 
-</details>
+## Sound control
-
-### Sound control
-
-<details>
-<summary>Click to expand</summary>
 
 - `sound-up`
 - `sound-down`
@@ -35,52 +22,30 @@
 - `sound-output`
 - `sound-change <up/down/mute> <increment>`
 
-</details>
+## Caffeine
-
-### Caffeine
-
-<details>
-<summary>Click to expand</summary>
 
 Caffeine is a simple script that toggles hypridle (disable suspend & screenlock).
 
 - `caffeine` # Toggle caffeine
 - `caffeine-status` # Return active/inactive
 
-</details>
+## Night-Shift
-
-### Night-Shift
-
-<details>
-<summary>Click to expand</summary>
 
 Blue light filter, using wlsunset
 
 - `night-shift-on`
 - `night-shift-off`
 
-</details>
+## Nerdfont FZF
-
-### Nerdfont FZF
-
-<details>
-<summary>Click to expand</summary>
 
 Nerdfont fzf is a quick way to search for nerdfont icons locally.
 It will copy the selected icon to the clipboard.
 
 - `nerdfont-fzf`
 
-</details>
+## Compress/Extract
-
-### Compress/Extract
-
-<details>
-<summary>Click to expand</summary>
 
 Some shortcut to compress and extract files.
 
 - `compress` ...
 - `extract` ...
-
-</details>

docs/THEMES.md

@@ -0,0 +1,11 @@
+# Themes
+
+Themes are defined in `hosts/themes`. Those themes define the colors, fonts, icons, etc, used by Hyprland and the apps installed.
+You can change the selected theme by changing the import statement at the top of your host's variables file.
+
+*To apply the theme to duckduckgo, follow the instructions in `$HOME/.duckduckgo-colorscheme.js`.*
+
+## Create your own theme
+
+Create a copy of one of the existing theme and change the variables.
+Wallpapers are loaded from the `home/wallpapers` folder.

docs/TODO.md

@@ -0,0 +1,13 @@
+# Todolist
+
+- [ ] Find a new icon theme (White, flat)
+- [ ] Global font-size config (Alt font size for waybar)
+- [ ] Catppuccin theme
+- [ ] Windows theme
+- [ ] MacOS theme
+- [ ] Rice screenshot script
+- [ ] Global variable for config location
+- [ ] Obsidian conditional import
+- [ ] Nixvim
+    - [ ] Telescope shortcut for file content
+    - [ ] Markdown snippets

docs/contribute.md

@@ -1 +0,0 @@
-# Contributing

docs/themes.md

@@ -1,24 +0,0 @@
-## Settings, Themes and colors
-
-*Nixy Theme:*
-
-Font:
-   Default: SF Apple
-   Mono: MesloLG Nerd Font
-   GTK Theme: FlatColor (Based on the colors in variables.nix)
-   QT Theme: Follow GTK
-   Icons:
-   Cursor:
-
-*Create your own:*
-
-In your hosts configuration, you should add a `variables.nix` file to manage your settings, including:
-
-- user information
-- timezone and locale
-- keyboard layout
-- the theme: will be used in programs and for GTK and QT themes
-- ... (check the `hosts/guest/variables.nix` file for more information)
-
-PS: To apply the theme to duckduckgo, follow the instructions in `$HOME/.duckduckgo-colorscheme.js`.
-

docs/todo.md

@@ -1 +0,0 @@
-- [ ] Example