readme: add one

This commit is contained in:
LavaDesu 2021-11-19 15:07:09 +07:00
parent e634c7826c
commit 3f09d77c91
Signed by: cilly
GPG key ID: 6500251E087653C9
3 changed files with 24 additions and 0 deletions

24
README.md Normal file
View file

@ -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