sugar/templates
1
0
Fork 0
forked from auxolotl/templates
Code Pull requests Activity
Nix templates for quickly bootstrapping a system with Auxpkgs
63 commits 4 branches 0 tags 431 KiB
Find a file
Exact
Raphael Borun Das Gupta 3fda15c3f9 refactor(system): move system.stateVersion comment out of nix.* (#34) 
Move comment about `system.stateVersion` out of attrset `nix`, as it has nothing to do with the `nix.*` options, but belongs with the `system.stateVersion` option below (after) attrset `nix`.

(This is also where this comment originally was, until it was moved in [47129554e4](47129554e4).)

Reviewed-on: auxolotl/templates#34
Reviewed-by: Skyler Grey <minion@clicks.codes>
Co-authored-by: Raphael Borun Das Gupta <git@raphael.dasgupta.ch>
Co-committed-by: Raphael Borun Das Gupta <git@raphael.dasgupta.ch>
2024-07-18 20:03:04 +00:00
.github/workflows ci: Added nixfmt and statix 2024-05-05 19:24:58 +05:30
c chore: change to nixos/nixpkgs 2024-05-18 09:28:57 +01:00
darwin chore: ignore some inputs 2024-05-18 09:29:07 +01:00
direnv Fix: Update nixpkgs url for new roadmap 2024-05-11 16:30:01 -04:00
home-manager Fix: Update home-manager 2024-05-11 16:31:56 -04:00
system refactor(system): move system.stateVersion comment out of nix.* (#34) 2024-07-18 20:03:04 +00:00
.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 Fix: Update nixpkgs url for new roadmap 2024-05-11 16:30:01 -04:00
README.md Update README.md - incorrect commands 2024-05-17 16:59:34 +10:00

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 - 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 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 --extra-experimental-features nix-command --extra-experimental-features flakes flake new -t github: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 github: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