this repo has no description
docs: update instructions
+50
-6
+2
-2
Makefile
+2
-2
Makefile
···
1
1
.POSIX:
2
-
.PHONY: default build test diff update
2
+
.PHONY: default build test diff update install
3
3
4
4
default: build
5
5
···
36
36
run 'github:nix-community/disko/latest#disko-install' -- \
37
37
--write-efi-boot-entries \
38
38
--flake '.#${host}' \
39
-
--disk main '${device}'
39
+
--disk main '${disk}'
+48
-4
README.md
+48
-4
README.md
···
1
1
# NixOS Setup
2
2
3
+
Automatically install and configure NixOS.
4
+
3
5
## Usage
4
6
5
-
Open a shell with the build dependencies:
7
+
### Customize the configuration
8
+
9
+
Review all files and adjust the configurations to suit your needs. At a
10
+
minimum, you’ll need to change the following:
11
+
12
+
- Users:
13
+
- Replace `khuedoan` with your username.
14
+
- Replace my SSH public keys with yours.
15
+
- Replace `khuedoan/dotfiles` with your dotfiles repository, or use `home-manager` to manage all dotfiles.
16
+
17
+
- Hosts:
18
+
- Replace my hostnames with yours.
19
+
- Adjust hardware configurations to match your system.
20
+
21
+
### Install with the NixOS Live CD
22
+
23
+
1. Download the latest NixOS live CD from [here](https://nixos.org/download).
24
+
2. Create a bootable USB drive:
6
25
7
26
```sh
8
-
nix-shell -p git neovim
27
+
sudo dd bs=4M if=/path/to/nixos.iso of=/dev/sda conv=fsync oflag=direct status=progress
9
28
```
10
29
11
-
Clone the repository and build:
30
+
3. Boot from the USB drive.
31
+
4. Install NixOS from the live CD:
12
32
13
33
```sh
14
-
sudo git clone https://github.com/khuedoan/nixos-setup
34
+
nix-shell -p git gnumake neovim
35
+
git clone https://github.com/khuedoan/nixos-setup
15
36
cd nixos-setup
37
+
# Remember to replace the placeholders
38
+
make install host=HOSTNAME disk=/dev/DISK
39
+
```
40
+
41
+
### Apply changes
42
+
43
+
After installation, clone your repository again and apply changes to the
44
+
configuration by running:
45
+
46
+
```sh
16
47
make
17
48
```
49
+
50
+
### Update hardware configuration
51
+
52
+
If hardware changes occur, update the hardware configuration using the command
53
+
in the `install` target in `./Makefile`.
54
+
55
+
## Testing
56
+
57
+
To test updated configurations without applying them to a running machine, create a VM using:
58
+
59
+
```sh
60
+
make test
61
+
```