flake/README.md

71 lines
1.9 KiB
Markdown
Raw Normal View History

2023-09-19 00:17:43 +00:00
# nix{os,-darwin} config
2023-10-31 09:19:51 +00:00
It just works™
2023-09-19 00:17:43 +00:00
2023-10-31 09:19:51 +00:00
## Infomation
- Flakes: Yes
- Home Manager: Yes
2023-11-03 15:04:38 +00:00
### Machine-specific (81fw-nixos)
2023-10-31 09:19:51 +00:00
- File system: Btrfs
- System encryption: Yes (LUKS)
2023-11-03 15:04:38 +00:00
### User-specific (me)
2023-10-31 09:19:51 +00:00
- Secrets: sops-nix
- Display server: Wayland
- Desktop-environment: Sway
## Structure
```
 .
├──  darwin # System configuration
├──  nixos
├──  flakes # Import-able Flakes
│ ├──  darwin
│ └──  nixos
├──  machines # Hardware configuration
│ ├──  darwin
│ └──  nixos
│ ├──  81fw-lenovo-legion-y7000 ### Model
│ │ ├──  hardware.nix #### Model-specific hardware configuration
│ │ └──  machine-1 #### Machine-specific hardware configuration
│ │
│ └───  hardware ### Reusable hardware configuration
│ ├──  cpu
│ ├──  gpu
│ └──  ...
├──  users
│ └──  guanranwang ## Your user
│ │
│ ├──  darwin ### (User-specific) System configuration
│ ├──  nixos
│ │
│ ├──  home-manager ### (User-specific) Home Manager configuration
│ │ ├──  darwin
│ │ └──  nixos
│ │
│ └──  secrets ### User's secrets managed through sops-nix
├──  flake.nix
├──  flake.lock
└──  README.md
```
## Installation:
~~Please don't.~~
1.
Clone this repository
`$ git clone https://github.com/Guanran928/flake.git`
2.
Add your device's hardware configuration in `./machines` and `./flake.nix`
3.
Install NixOS
`$ nixos-install --flake <this flake's directory>#<hostname>`