From 05932e597c44318ae1e1b89d9a504e0278a945c7 Mon Sep 17 00:00:00 2001 From: Hadi <112569860+anotherhadi@users.noreply.github.com> Date: Tue, 18 Jun 2024 19:05:40 +0200 Subject: [PATCH] Update --- README.md | 166 +++++++++++++++++----------------- docs/scripts/create_readme.sh | 6 +- hosts/guest/variables.nix | 1 - 3 files changed, 87 insertions(+), 86 deletions(-) diff --git a/README.md b/README.md index 0d3d2a2..3637739 100644 --- a/README.md +++ b/README.md @@ -1,83 +1,83 @@ -[//]: # (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/18/24) - -
- -![test](docs/src/logo.png) - -
- -# Nixy - -
-
- - - - - - - - - - - - - - - -
-
- -**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 - - - [Table of Content](#table-of-content) - - [Gallery](#gallery) - - [Architecture](#architecture) - - [Installation](#installation) - - [Documentation](#documentation) - -## Gallery - -![catppuccin1](docs/src/catppuccin/1.png) -![catppuccin2](docs/src/catppuccin/2.png) -![catppuccin3](docs/src/catppuccin/3.png) - -## Architecture - -- 🏠 `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`) - - '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, ...) -- 🤫 `secrets` are the secrets files encrypted with sops-nix - -## Installation - -```sh -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 host's folder -- Add your 'nixosConfigurations' inside `flake.nix` (You can edit the "yourhostname" one and change the lines containing '# CHANGEME') - -```sh -sudo nixos-rebuild switch --flake ~/.config/nixos#yourhostname -``` - -## Documentation - -- [THEMES.md](docs/THEMES.md): How themes work and how to create your own -- [APPS.md](docs/APPS.md): Which apps are installed -- [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 Licensey +[//]: # (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/18/24) + +
+ +
+ +
+ +# Nixy + +
+
+ + + + + + + + + + + + + + + +
+
+ +**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 + + - [Table of Content](#table-of-content) + - [Gallery](#gallery) + - [Architecture](#architecture) + - [Installation](#installation) + - [Documentation](#documentation) + +## Gallery + +![catppuccin1](docs/src/catppuccin/1.png) +![catppuccin2](docs/src/catppuccin/2.png) +![catppuccin3](docs/src/catppuccin/3.png) + +## Architecture + +- 🏠 `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`) + - '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, ...) +- 🤫 `secrets` are the secrets files encrypted with sops-nix + +## Installation + +```sh +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 host's folder +- Add your 'nixosConfigurations' inside `flake.nix` (You can edit the "yourhostname" one and change the lines containing '# CHANGEME') + +```sh +sudo nixos-rebuild switch --flake ~/.config/nixos#yourhostname +``` + +## Documentation + +- [THEMES.md](docs/THEMES.md): How themes work and how to create your own +- [APPS.md](docs/APPS.md): Which apps are installed +- [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 Licensey diff --git a/docs/scripts/create_readme.sh b/docs/scripts/create_readme.sh index 3fde57f..80e3084 100644 --- a/docs/scripts/create_readme.sh +++ b/docs/scripts/create_readme.sh @@ -15,5 +15,7 @@ header=${header//\{primarycolor\}/89b4fa} header=${header//\{backgroundcolor\}/181825} readme_content=${readme_content//\{md_table_of_content\}/$table_of_content} -echo "$header" > "$README_FILE" -echo "$readme_content" >> "$README_FILE" \ No newline at end of file +echo "$header" >"$README_FILE" +echo "$readme_content" >>"$README_FILE" +sed 's/\r//' "$README_FILE" >"/tmp/readme.md" +mv "/tmp/readme.md" "$README_FILE" diff --git a/hosts/guest/variables.nix b/hosts/guest/variables.nix index 4f240f5..ffa0a2d 100644 --- a/hosts/guest/variables.nix +++ b/hosts/guest/variables.nix @@ -22,7 +22,6 @@ autoUpgrade = false; autoGarbageCollector = false; - nextcloud = false; # change the sops configuration if you want to enable that: sops = false; # change the nvim's obsidian configuration if you want to enable that: