updated README

This commit is contained in:
Bryan Ramos 2024-05-14 10:51:51 -04:00
parent 1c4c434e50
commit b6db2c98b6
Signed by: bryan
GPG key ID: 6ABDCD144D6643C8

View file

@ -2,14 +2,15 @@
My modular Nix configs🔥 My modular Nix configs🔥
## Requirements ⚙️ ## Requirements ⚙️
### NixOS Configurations
- [NixOS](https://www.nixos.org/)
- [Nix 2.0 & Flakes enabled](https://nixos.wiki/wiki/Flakes#Enable_flakes_permanently_in_NixOS) - [Nix 2.0 & Flakes enabled](https://nixos.wiki/wiki/Flakes#Enable_flakes_permanently_in_NixOS)
### Home-Manager Configuration
### NixOS Configurations
- [NixOS](https://www.nixos.org/)
### Home-Manager Configuration
- [Nix Home-Manager](https://nix-community.github.io/home-manager/index.xhtml#sec-flakes-standalone) - [Nix Home-Manager](https://nix-community.github.io/home-manager/index.xhtml#sec-flakes-standalone)
# Flake End-Points Exposed ❄️ # Flake End-Points Exposed ❄️
NixOS Configurations: NixOS Configurations:
- desktop - desktop
- wsl - wsl
@ -27,11 +28,11 @@ If you need a list of available packages and options:
- [nixpkgs Options](https://search.nixos.org/options?) 🔍️ - [nixpkgs Options](https://search.nixos.org/options?) 🔍️
- [Home-Manager Options](https://mipmip.github.io/home-manager-option-search/) ☕️ - [Home-Manager Options](https://mipmip.github.io/home-manager-option-search/) ☕️
Invoke `nix develop` to enter a development shell powered by [`just`](https://github.com/casey/just) Invoke `nix develop` to enter a development shell powered by [`just`](https://github.com/casey/just)
Invoke `just` in order to view an available list of project scripts Invoke `just` in order to view an available list of project scripts
`user.configs.nix` is a symlink to conveniently access centrally defined common user variables from the repo root `user.configs.nix` is a symlink to conveniently access centrally defined common user variables from the repo root
⚠️ Be sure to tailor any hardware settings to your own ⚠️ Be sure to tailor any hardware settings to your own
⚠️ Replace the `hardware.nix` found in the `src/system/machines/<machine>` directory ⚠️ Replace the `hardware.nix` found in the `src/system/machines/<machine>` directory
⚠️ Run `nixos-generate-config` to generate a `hardware-configuration.nix` for your current system ⚠️ Run `nixos-generate-config` to generate a `hardware-configuration.nix` for your current system