diff --git a/apps/README.md b/apps/README.md new file mode 100644 index 0000000..eadcea4 --- /dev/null +++ b/apps/README.md @@ -0,0 +1,9 @@ +# Apps + +These are all my miscellaneous utilies and scripts to accompany this project. + +They can be run with: + +``` +nix run github:nmasur/dotfiles#appname +``` diff --git a/colorscheme/README.md b/colorscheme/README.md new file mode 100644 index 0000000..2df020e --- /dev/null +++ b/colorscheme/README.md @@ -0,0 +1,5 @@ +# Colorschemes + +Color information for different themes is found here. The colors are sourced +and used with [base16](https://github.com/chriskempson/base16) format +consistently across the system. diff --git a/disks/README.md b/disks/README.md new file mode 100644 index 0000000..43bc5dc --- /dev/null +++ b/disks/README.md @@ -0,0 +1,5 @@ +# Disks + +These are my [disko](https://github.com/nix-community/disko) configurations, +which allow me to save desired disk formatting layouts as a declarative file so +I don't have to remember how to format my disks later on. diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..8667c77 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,4 @@ +# Documentation + +Reference documents for some of the more complicated services and maintenance +tasks. diff --git a/hosts/README.md b/hosts/README.md index 052c3b4..56794d2 100644 --- a/hosts/README.md +++ b/hosts/README.md @@ -1,5 +1,7 @@ # Hosts +These are the individual machines managed by this flake. + | Host | Purpose | | --- | --- | | [aws](./aws/default.nix) | AWS AMI | diff --git a/misc/README.md b/misc/README.md new file mode 100644 index 0000000..6237e96 --- /dev/null +++ b/misc/README.md @@ -0,0 +1,21 @@ +# Miscellaneous + +These files contain important data sourced by the configuration, or simply +information to store for safekeeping later. + +--- + +Creating hashed password for [password.sha512](./password.sha512): + +``` +mkpasswd -m sha-512 +``` + +--- + +Getting key for [public-keys](./public-keys): + +``` +ssh-keyscan -t ed25519 +``` + diff --git a/modules/README.md b/modules/README.md index 69c963d..74fd03b 100644 --- a/modules/README.md +++ b/modules/README.md @@ -5,4 +5,5 @@ | [common](./common/default.nix) | User programs and OS-agnostic configuration | | [darwin](./darwin/default.nix) | macOS-specific configuration | | [nixos](./nixos/default.nix) | NixOS-specific configuration | +| [wsl](./wsl/default.nix) | WSL-specific configuration | diff --git a/overlays/README.md b/overlays/README.md new file mode 100644 index 0000000..487d771 --- /dev/null +++ b/overlays/README.md @@ -0,0 +1,7 @@ +# Overlays + +These are pinned commits, patches, or new packages for programs in Nixpkgs used +by this flake configuration. + +Some of them introduce new functionality, while others could be patching +temporary issues. diff --git a/templates/README.md b/templates/README.md new file mode 100644 index 0000000..c810907 --- /dev/null +++ b/templates/README.md @@ -0,0 +1,8 @@ +# Templates + +These are new flakes that can be generated quickly using: + +``` +nix flake init -t github:nmasur/dotfiles#mytemplate +``` +