From 6d0855ce444e0dbed7e3790969bc65230d956307 Mon Sep 17 00:00:00 2001 From: Hadi <112569860+anotherhadi@users.noreply.github.com> Date: Tue, 25 Jun 2024 18:02:38 +0200 Subject: [PATCH] Update --- README.md | 7 ++++--- docs/CONTRIBUTING.md | 3 +++ docs/src/README_template.md | 2 +- 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3d60603..e14bd6c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ [//]: # (Title: Nixy) [//]: # (Description: 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.) [//]: # (Author: Hadi) -[//]: # (Date: 06/24/24) +[//]: # (Date: 06/25/24) +[//]: # (Version: v2.0.0)
@@ -14,7 +15,7 @@
- + @@ -53,7 +54,7 @@ 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 configuration for my laptop with Nvidia - - 'server' is for my Nixos server (w/nextcloud, nginx, vaultwarden, ... look `hosts/modules/server`) + - 'server' is for my Nixos server (w/nextcloud, nginx, vaultwarden, ... look `hosts/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, ...) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index a26f4cb..1456bc6 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -8,3 +8,6 @@ The process is straight-forward. - Fork Nixy [git repository](https://github.com/anotherhadi/nixy). - Write your changes (new theme, bug fixes, task in todo, ...). - Create a Pull Request against the main branch of Nixy. + +> [!WARNING] +> Don't push your host's files, secrets, or home configuration diff --git a/docs/src/README_template.md b/docs/src/README_template.md index cf51f10..64fe85a 100644 --- a/docs/src/README_template.md +++ b/docs/src/README_template.md @@ -17,7 +17,7 @@ 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 configuration for my laptop with Nvidia - - 'server' is for my Nixos server (w/nextcloud, nginx, vaultwarden, ... look `hosts/server`) + - 'server' is for my homeserver (w/nextcloud, nginx, vaultwarden, ... look `hosts/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, ...)