auxolotl/templates
20
2
Fork 4
Code Issues 3 Pull requests 2 Actions Packages Projects Releases Wiki Activity
Nix templates for quickly bootstrapping a system with Auxpkgs
27 commits 3 branches 0 tags 532 KiB
Nix 97%
Makefile 1.9%
C 1.1%
Go to file
Abhiram b0ab59541e
Merge pull request #18 from auxolotl/feat/contrib 
added: contributing.md
2024-05-03 02:03:30 +05:30
darwin fix(darwin): config argument missing on system.nix 2024-05-02 16:27:13 +02:00
home-manager Merge pull request #3 from getchoo/modules 2024-05-02 09:31:39 +00:00
system Merge pull request #10 from aemogie/feat/system-nixpkgs-revision 2024-05-02 21:07:48 +05:30
.gitignore chore: ignore template flake.locks 2024-05-02 13:01:26 +05:30
CONTRIBUTING.md docs: contributing 2024-05-02 21:10:36 +01:00
flake.lock Fix flake lock 2024-05-02 18:08:54 +02:00
flake.nix pass nixpkgs directly in forAllSystems 2024-05-01 17:38:50 -04:00
README.md fix: badges artifacts 2024-05-02 18:41:24 +01:00

README.md

Welcome to Aux

This is a template repository for getting started with your brand new FreshwaterOS 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 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 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 flake new -t github:auxolotyl/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 flake new -t github:auxolotyl/templates#home-manager NixFiles to start
  2. Move into your new Nix system with cd NixFiles
  3. Fill in your username in flake.nix