From 79bd9997a5b20803282caf4550dc3510f941411f Mon Sep 17 00:00:00 2001 From: Guanran Wang Date: Fri, 29 Dec 2023 23:34:58 +0800 Subject: [PATCH] docs: update readme --- README.md | 39 +++++++++++++++------------------------ 1 file changed, 15 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index ba8c84a..29101dc 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,16 @@ # nix{os,-darwin} config + It just works™ - -## Infomation -- Flakes: Yes -- Home Manager: Yes - -### Machine-specific (Aristotle) -- File system: Btrfs -- System encryption: Yes (LUKS) - -### User-specific (me) -- Secrets: sops-nix -- Display server: Wayland -- Desktop-environment: Sway - ## Structure + ```  . │ ### System configuration +│ # Darwin configuration is not actively maintained and sometimes it might break. ├──  darwin ├──  nixos -│ ├──  hardware +│ ├──  hosts │ ├──  modules │ └──  profiles │ @@ -38,17 +27,19 @@ It just works™ │ └──  README.md ``` + ## Installation: - ~~Please don't.~~ +Please don't. - 1. - Clone this repository - `$ git clone https://github.com/Guanran928/flake.git` +### NixOS: - 2. - Add your device's hardware configuration in `./ (nixos/darwin) /hardware` and `./flake.nix` +1. Clone this repository - 3. - Install NixOS - `$ nixos-install --flake #` + `$ git clone https://github.com/Guanran928/flake.git` + +2. Add your device's hardware configuration in `./flake.nix` and `./nixos/hosts/` + +3. Install NixOS + + `$ nixos-install --flake #`