From 988ec394e479c0e512f43d4fe56e489426bc620c Mon Sep 17 00:00:00 2001 From: Aly Raffauf Date: Mon, 4 Mar 2024 23:42:20 -0500 Subject: [PATCH] expanded README --- README.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4de9acf8..2f6dcdbf 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,30 @@ # nixcfg ![](./_img/nixos-gnome.png) +## Hosts + +### Petalburg +Lenovo Yoga 9i Gen 8 convertible running nixos-unstable. Core i7 1360P, 15GB RAM, 512GB SSD. Runs GNOME, home directory managed by [home-manager](https://github.com/nix-community/home-manager). + +### Rustboro +Thinkpad T440p running nixos-unstable. Uses KDE Plasma 6. Home directory managed by home-manager. + +### Mauville +Gaming desktop & home lab running [Slateblue](https://github.com/alyraffauf/slateblue), a customized [Fedora Silverblue](https://fedoraproject.org/atomic-desktops/silverblue/) image made with [BlueBuild](https://github.com/blue-build/template). Home directory managed by home-manager. Ryzen 5 2600, 16GB RAM, Radeon RX 6700. + ## Deploying to NixOS > :red_circle: **READ**: **Do not deploy this flake directly to your machine. It won't work.** -> This is my own NixOS and home-manager flake for my personal devices. -> This includes laptops running nixos-unstable and a home lab/gaming desktop running [Slateblue](https://github.com/alyraffauf/slateblue), -> a customized [Fedora Silverblue](https://fedoraproject.org/atomic-desktops/silverblue/) image made with [BlueBuild](https://github.com/blue-build/template). +> This is my own [NixOS](https://nixos.org/) and [home-manager](https://github.com/nix-community/home-manager) flake for my personal devices. > Each hardware-configuration is host-specific. If you fork this repository, replace them with the hardware-configuration.nix that NixOS generates for you. ### Enabling Flakes -Add the following lines to your `configuration.nix` and rebuild. +While widely used and considered stable, [flakes](https://nixos.wiki/wiki/Flakes) are still considered eperimental. To enable Flakes, add the following lines to your `configuration.nix` and rebuild. ```nix nix.settings.experimental-features = [ "nix-command" "flakes" ]; ``` ### Building Flake -Run the following command. -```bash +In order to deploy this Flake on your host, run the following command: +``` sudo nixos-rebuild boot --flake github:alyraffauf/nixcfg ``` -Reboot and the flake's configuration will be applied. +Reboot to apply the flake's configuration for the chosen host.