nyancat/flake
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: update readme

Browse source
This commit is contained in:
Guanran Wang 2023-12-29 23:34:58 +08:00
parent 671a81a366
commit 79bd9997a5
Signed by: nyancat
SSH key fingerprint: SHA256:8oWGKciPALWut/6WA27oFKofX+6Wtc0gQnsefXLQx/8
1 changed files with 15 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
README.md
View file

@ -1,27 +1,16 @@
# nix{os,-darwin} config # nix{os,-darwin} config
It just works™ 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 ## Structure
``` ```
 .  .
│ ### System configuration │ ### System configuration
│ # Darwin configuration is not actively maintained and sometimes it might break.
├──  darwin ├──  darwin
├──  nixos ├──  nixos
│ ├──  hardware │ ├──  hosts
│ ├──  modules │ ├──  modules
│ └──  profiles │ └──  profiles
│ │
@ -38,17 +27,19 @@ It just works™
│ │
└──  README.md └──  README.md
``` ```
## Installation: ## Installation:
~~Please don't.~~ Please don't.
### NixOS:
1. Clone this repository
1.
Clone this repository
`$ git clone https://github.com/Guanran928/flake.git` `$ git clone https://github.com/Guanran928/flake.git`
2. 2. Add your device's hardware configuration in `./flake.nix` and `./nixos/hosts/<hostname>`
Add your device's hardware configuration in `./ (nixos/darwin) /hardware` and `./flake.nix`
3. Install NixOS
3.
Install NixOS
`$ nixos-install --flake <this flake's directory>#<hostname>` `$ nixos-install --flake <this flake's directory>#<hostname>`