diff --git a/README.md b/README.md index c15328d..4ab558b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,54 @@ # Wyatt's Nix configuration Designed and developed by Wyatt J. Miller, 2024 + +Licensed by the Mozilla Public License v2 + +## What is this?? + +This repository is my multi-machine Nix configuration, written in a Nix flake! + +## How do I get this? + +Make sure the following is installed: + +- `git` (most operating systems come with git already installed) +- `nix` (if you are on macOS or a non-NixOS system) + +If you don't have `git` installed and are running macOS, run the following command: + +```bash +sudo xcode-select +``` + +If you don't have `nix` installed and are running Linux, use the Determinate Nix Installer! + +```bash +curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install +``` + +If you don't have `nix` installed and are running macOS, use the Determinate Nix Installer! + +```bash +curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install +``` + +There's a separate installer Determinate System's + +## How do I run this? + +For NixOS systems: + +```bash +sudo nixos-rebuild switch --flake .# +``` + +For macOS systems: + +```bash +nix run nix-darwin --extra-experimental-features nix-command --extra-experimental-features flakes -- switch --flake .# +``` + +where `` is the particular configuration you would like to run. + +Non-NixOS Linux systems should be coming soon!