diff --git a/.github/screenshots/desktop.png b/.github/screenshots/desktop.png new file mode 100644 index 0000000..a37242f Binary files /dev/null and b/.github/screenshots/desktop.png differ diff --git a/.github/screenshots/neovim.png b/.github/screenshots/neovim.png new file mode 100644 index 0000000..030fff1 Binary files /dev/null and b/.github/screenshots/neovim.png differ diff --git a/README.md b/README.md new file mode 100644 index 0000000..479faf9 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# flakes +My NixOS config! + +![Desktop](.github/screenshots/desktop.png?raw=true) +![Neovim](.github/screenshots/neovim.png?raw=true) + +## Usage +I recommend more that you only simply look at the modules as inspiration for your own config. Some of them +may or may not work on your machine if copied directly (but theoretically they should). + +But if you insist, just copy-paste one of the hosts in `hosts/`, one of the users in `users/`, and modify them +to your liking. Open up `flake.nix`, add your new host config at the bottom, and then build it! + +## Host naming +| Name | Description | +| ------- | ----------- | +| apricot | Homeserver | +| blossom | Laptop and main PC | +| fondue | VM lent by [a friend](https://github.com/Aiamded) in Australia | + +## License +Licensed under CC0; basically you can fork, modify, redistribute, or do whatever you want I don't really care. + +Credit is appreciated but not necessary