20cccae696
chore(system): update top-level Readme file |
||
---|---|---|
.github/workflows | ||
c | ||
darwin | ||
direnv | ||
home-manager | ||
system | ||
.gitignore | ||
CONTRIBUTING.md | ||
flake.lock | ||
flake.nix | ||
README.md |
Welcome to Aux
This is a template repository for getting started with your brand new Auxolotl system.
Getting Started
There are 3 main templates in this repository:
darwin
- The system configuration for the Darwin operating system (macOS)system
- A complete NixOS system configuration template for the Linux operating systemhome-manager
- The configuration for the home-manager
With Darwin (macOS)
- Run
nix --extra-experimental-features nix-command --extra-experimental-features flakes flake new -t github:auxolotl/templates#darwin NixFiles
in the terminal. This will setup the basic configuration for the system, this generate a configuration for you from the files located in thedarwin
directory. - The next step is to go into the
NixFiles
directory this can be achieved by runningcd NixFiles
. - Now we you need to read over the configuration files and make any changes that you see fit, some of these must include changing your username and hostname.
- You now must rebuild this configuration we can do this with
nix run darwin -- switch --flake .#hostname
hostname should be substituted for your systems hostname. - After your first run you are now able to use the
darwin-rebuild switch --flake .
command to rebuild your system.
With NixOS
- Install a base NixOS system
- Run
nix --extra-experimental-features nix-command --extra-experimental-features flakes flake new -t github:auxolotl/templates#system NixFiles
- Move into your new system with
cd NixFiles
- Fill in your
hostName
inflake.nix
- Run
nixos-generate-config --show-hardware-config > host/hardware-configuration.nix
to generate configuration based on your filesystems and drivers - Edit the
host/configuration.nix
file with your desired system configuration - Run
nixos-rebuild build --flake .#hostName
, replacing hostName with your new hostName
Congratulations, you are now using NixOS!
With Home-manager
- Run
nix --extra-experimental-features nix-command --extra-experimental-features flakes flake new -t github:auxolotl/templates#home-manager NixFiles
to start - Move into your new Nix system with
cd NixFiles
- Fill in your
username
inflake.nix