From bfed924f0f325bbe32ae5878cd0130c732675a58 Mon Sep 17 00:00:00 2001 From: Hadi <112569860+anotherhadi@users.noreply.github.com> Date: Tue, 18 Jun 2024 12:30:56 +0200 Subject: [PATCH] Update --- README.md | 18 +++++++++--------- docs/SCRIPTS.md | 2 +- docs/THEMES.md | 6 +++--- docs/src/README_template.md | 16 ++++++++-------- 4 files changed, 21 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 28490fb..09745f3 100644 --- a/README.md +++ b/README.md @@ -33,14 +33,14 @@ -# Nixy +# Nix -**Nixy** is a Hyprland NixOS configuration with home-manager, secrets and custom theming all in one place. +**Nixy** is a Hyprland NixOS configuration with home-manager, secrets, and custom theming all in one place. It's a simple way to manage your system configuration and dotfiles. ## Table of Content -- [Nixy](#nixy) +- [Nix](#nix) - [Table of Content](#table-of-content) - [Gallery](#gallery) - [Architecture](#architecture) @@ -57,11 +57,11 @@ It's a simple way to manage your system configuration and dotfiles. - 🏠 `home` are the dotfiles and configuration files for the user - 💻 `hosts` are the system configuration files - - 'laptop' is my own configuration for my laptop with nvidia - - 'server' is for my nixos server (w/nextcloud, nginx, vaultwarden, ... look `hosts/modules/server`) + - 'laptop' is my configuration for my laptop with Nvidia + - 'server' is for my Nixos server (w/nextcloud, nginx, vaultwarden, ... look `hosts/modules/server`) - 'guest' is a *template* that you can copy and modify for *your own system* - 'themes' contains all the *themes* available (see [THEMES.md](docs/THEMES.md)) - - 'modules' are some nix modules that you can import (nvidia, prime, fonts, ...) + - 'modules' are some nix modules that you can import (Nvidia, prime, fonts, ...) - 🤫 `secrets` are the secrets files encrypted with sops-nix ## Installation @@ -70,8 +70,8 @@ It's a simple way to manage your system configuration and dotfiles. git clone https://github.com/anotherhadi/nixy ~/.config/nixos ``` -- Copy the `hosts/guest` folder, rename it to your system name and change the variables inside the `variables.nix` file -- Add your `hardware-configuration.nix` to your new hosts folder +- Copy the `hosts/guest` folder, rename it to your system name, and change the variables inside the `variables.nix` file +- Add your `hardware-configuration.nix` to your new host's folder - Add your 'nixosConfigurations' inside `flake.nix` (You can edit the "yourhostname" one and change the lines containing '# CHANGEME') ```sh @@ -85,4 +85,4 @@ sudo nixos-rebuild switch --flake ~/.config/nixos#yourhostname - [SCRIPTS.md](docs/SCRIPTS.md): Scripts that are available - [TODO.md](docs/TODO.md): What's next (feel free to contribute) - [CONTRIBUTING.md](docs/CONTRIBUTING.md): How to contribute -- [LICENSE](LICENSE): MIT License +- [LICENSE](LICENSE): MIT Licensey diff --git a/docs/SCRIPTS.md b/docs/SCRIPTS.md index 6bb017c..c040801 100644 --- a/docs/SCRIPTS.md +++ b/docs/SCRIPTS.md @@ -45,7 +45,7 @@ It will copy the selected icon to the clipboard. ## Compress/Extract -Some shortcut to compress and extract files. +Some shortcuts to compress and extract files. - `compress` ... - `extract` ... diff --git a/docs/THEMES.md b/docs/THEMES.md index 5296e04..8d6cecb 100644 --- a/docs/THEMES.md +++ b/docs/THEMES.md @@ -3,11 +3,11 @@ 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`.* +*To apply the theme to Duckduckgo, follow the instructions in `$HOME/.duckduckgo-colorscheme.js`.* -## Create your own theme +## Create your theme -Create a copy of one of the existing theme and change the variables. +Create a copy of one of the existing themes and change the variables. Wallpapers are loaded from the `home/wallpapers` folder. ## Gallery diff --git a/docs/src/README_template.md b/docs/src/README_template.md index e3d0cda..d68b3b1 100644 --- a/docs/src/README_template.md +++ b/docs/src/README_template.md @@ -1,7 +1,7 @@ -# Nixy +# Nix -**Nixy** is a Hyprland NixOS configuration with home-manager, secrets and custom theming all in one place. +**Nixy** is a Hyprland NixOS configuration with home-manager, secrets, and custom theming all in one place. It's a simple way to manage your system configuration and dotfiles. ## Table of Content @@ -18,11 +18,11 @@ It's a simple way to manage your system configuration and dotfiles. - 🏠 `home` are the dotfiles and configuration files for the user - 💻 `hosts` are the system configuration files - - 'laptop' is my own configuration for my laptop with nvidia - - 'server' is for my nixos server (w/nextcloud, nginx, vaultwarden, ... look `hosts/modules/server`) + - 'laptop' is my configuration for my laptop with Nvidia + - 'server' is for my Nixos server (w/nextcloud, nginx, vaultwarden, ... look `hosts/modules/server`) - 'guest' is a *template* that you can copy and modify for *your own system* - 'themes' contains all the *themes* available (see [THEMES.md](docs/THEMES.md)) - - 'modules' are some nix modules that you can import (nvidia, prime, fonts, ...) + - 'modules' are some nix modules that you can import (Nvidia, prime, fonts, ...) - 🤫 `secrets` are the secrets files encrypted with sops-nix ## Installation @@ -31,8 +31,8 @@ It's a simple way to manage your system configuration and dotfiles. git clone https://github.com/anotherhadi/nixy ~/.config/nixos ``` -- Copy the `hosts/guest` folder, rename it to your system name and change the variables inside the `variables.nix` file -- Add your `hardware-configuration.nix` to your new hosts folder +- Copy the `hosts/guest` folder, rename it to your system name, and change the variables inside the `variables.nix` file +- Add your `hardware-configuration.nix` to your new host's folder - Add your 'nixosConfigurations' inside `flake.nix` (You can edit the "yourhostname" one and change the lines containing '# CHANGEME') ```sh @@ -46,4 +46,4 @@ sudo nixos-rebuild switch --flake ~/.config/nixos#yourhostname - [SCRIPTS.md](docs/SCRIPTS.md): Scripts that are available - [TODO.md](docs/TODO.md): What's next (feel free to contribute) - [CONTRIBUTING.md](docs/CONTRIBUTING.md): How to contribute -- [LICENSE](LICENSE): MIT License +- [LICENSE](LICENSE): MIT Licensey