auxolotl/templates
20
2
Fork 4
Code Issues 3 Pull requests 2 Actions Packages Projects Releases Wiki Activity
templates/README.md
sugar🍬🍭🏳️‍⚧️ dcb9bc3396
Some checks failed
Code Check / Run nixfmt and statix (push) Has been cancelled
Details
fix: update flake url in readme (#35) 
Reviewed-on: #35
Reviewed-by: Skyler Grey <minion@clicks.codes>
Co-authored-by: sugar <sugar@sylveon.social>
Co-committed-by: sugar <sugar@sylveon.social>
2024-07-24 20:13:40 +00:00

2.6 KiB
Raw Blame History

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 - The system configuration for the Linux operating system
  • home-manager - The configuration for the home-manager

With Darwin (macOS)

  1. Run nix --extra-experimental-features nix-command --extra-experimental-features flakes flake new -t git+https://git.auxolotl.org/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 the darwin directory.
  2. The next step is to go into the NixFiles directory this can be achieved by running cd NixFiles.
  3. 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.
  4. 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.
  5. After your first run you are now able to use the darwin-rebuild switch --flake . command to rebuild your system.

With NixOS

  1. Run nix --extra-experimental-features nix-command --extra-experimental-features flakes flake new -t git+https://git.auxolotl.org/auxolotl/templates#system NixFiles
  2. Move into your new system with cd NixFiles
  3. Fill in your hostName in flake.nix
  4. Run nixos-generate-config --show-hardware-config > hardware-configuration.nix to generate configuration based on your filesystems and drivers
  5. Run nixos-rebuild build --flake .#hostName, replacing hostName with your new hostName

Congratulations, you are now using Aux!

With Home-manager

  1. Run nix --extra-experimental-features nix-command --extra-experimental-features flakes flake new -t git+https://git.auxolotl.org/auxolotl/templates#home-manager NixFiles to start
  2. Move into your new Nix system with cd NixFiles
  3. Fill in your username in flake.nix