diff --git a/README.md b/README.md new file mode 100644 index 0000000..c8671da --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# Lyes' NixOS and dotfiles collection + +This repo is divided as such: +- `hosts/` : Contains the configuration of hosts (hardware, networking...) +- `modules/` : Contains the configuration of related pieces of software + - `common/` : Common configuration for all devices + - `desktop/` : Contains configuration relevant to desktop software + - `server/` : Contains configuration relevant to server software +- `users/` : Contains user configuration (including home-manager) +- `pkgs/` : Contains custom packages for my own use (for now not importable as + an external flake, may do it upon request) + +This repo uses flakes, which can construct the following targets: +- `piaf` : For my framework 16 laptop +- `zora` : For my servers hoster at the [Crans](https://crans.org/) +- `triforce` : For my custom ISO creation + +Unless indicated otherwise by a comment (when code is taken from elsewhere), +everything in this repo is under the MIT-0 LICENSE. Meaning, you can copy +everything here without any restriction (not even attribution).