From 5e3a372259c6b90f8df9e253a3b630e8e7282f48 Mon Sep 17 00:00:00 2001 From: Hadi <112569860+anotherhadi@users.noreply.github.com> Date: Mon, 17 Jun 2024 16:53:18 +0200 Subject: [PATCH] update --- docs/{apps.md => APPS.md} | 9 ++---- docs/CONTRIBUTING.md | 10 +++++++ docs/{scripts.md => SCRIPTS.md} | 53 ++++++--------------------------- docs/THEMES.md | 11 +++++++ docs/TODO.md | 13 ++++++++ docs/contribute.md | 1 - docs/themes.md | 24 --------------- docs/todo.md | 1 - 8 files changed, 46 insertions(+), 76 deletions(-) rename docs/{apps.md => APPS.md} (87%) create mode 100644 docs/CONTRIBUTING.md rename docs/{scripts.md => SCRIPTS.md} (53%) create mode 100644 docs/THEMES.md create mode 100644 docs/TODO.md delete mode 100644 docs/contribute.md delete mode 100644 docs/themes.md delete mode 100644 docs/todo.md diff --git a/docs/apps.md b/docs/APPS.md similarity index 87% rename from docs/apps.md rename to docs/APPS.md index 1749f9b..87acd54 100644 --- a/docs/apps.md +++ b/docs/APPS.md @@ -1,6 +1,6 @@ +# APPS -
-Click to show installed apps +*non-exhaustive list* | Category | Software | |----------------|---------------| @@ -30,7 +30,4 @@ | Misc | lazygit | | | neofetch | | | cava | -| | ... | - -
- +| | ... | \ No newline at end of file diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 0000000..9a18f91 --- /dev/null +++ b/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. \ No newline at end of file diff --git a/docs/scripts.md b/docs/SCRIPTS.md similarity index 53% rename from docs/scripts.md rename to docs/SCRIPTS.md index 9df12a0..27089e8 100644 --- a/docs/scripts.md +++ b/docs/SCRIPTS.md @@ -1,9 +1,6 @@ -## Scripts +# Scripts -### Nix/NixOs shortcuts - -
-Click to expand +## Nix/NixOs shortcuts - `nixy-edit` - `nixy-rebuild` @@ -11,23 +8,13 @@ - `nixy-gc` # garbage collection - `nixy-cb` # clean boot menu -
- -### Brightness control - -
-Click to expand +## Brightness control - `brightness-up` - `brightness-down` - `brightness-change ` -
- -### Sound control - -
-Click to expand +## Sound control - `sound-up` - `sound-down` @@ -35,52 +22,30 @@ - `sound-output` - `sound-change ` -
- -### Caffeine - -
-Click to expand +## Caffeine Caffeine is a simple script that toggles hypridle (disable suspend & screenlock). - `caffeine` # Toggle caffeine - `caffeine-status` # Return active/inactive -
- -### Night-Shift - -
-Click to expand +## Night-Shift Blue light filter, using wlsunset - `night-shift-on` - `night-shift-off` -
- -### Nerdfont FZF - -
-Click to expand +## Nerdfont FZF Nerdfont fzf is a quick way to search for nerdfont icons locally. It will copy the selected icon to the clipboard. - `nerdfont-fzf` -
- -### Compress/Extract - -
-Click to expand +## Compress/Extract Some shortcut to compress and extract files. - `compress` ... -- `extract` ... - -
\ No newline at end of file +- `extract` ... \ No newline at end of file diff --git a/docs/THEMES.md b/docs/THEMES.md new file mode 100644 index 0000000..b6df198 --- /dev/null +++ b/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. \ No newline at end of file diff --git a/docs/TODO.md b/docs/TODO.md new file mode 100644 index 0000000..7543851 --- /dev/null +++ b/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 \ No newline at end of file diff --git a/docs/contribute.md b/docs/contribute.md deleted file mode 100644 index 4d218d9..0000000 --- a/docs/contribute.md +++ /dev/null @@ -1 +0,0 @@ -# Contributing \ No newline at end of file diff --git a/docs/themes.md b/docs/themes.md deleted file mode 100644 index 7e1073e..0000000 --- a/docs/themes.md +++ /dev/null @@ -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`. - diff --git a/docs/todo.md b/docs/todo.md deleted file mode 100644 index 4e18333..0000000 --- a/docs/todo.md +++ /dev/null @@ -1 +0,0 @@ -- [ ] Example \ No newline at end of file