docs: add readme.md

This commit is contained in:
hexchen 2021-01-11 00:22:37 +00:00
parent 1399f74e87
commit f5c9d5f0c7

21
README.md Normal file
View file

@ -0,0 +1,21 @@
# hacc nixfiles
welcome to hacc nixfiles (haccfiles). this is the code describing our nix-based infrastructure.
## structure
- `default.nix`: Entrypoint to the config
- `common/`: configuration common to all hosts
- `desktop/`: desktop-relevant communication
- `modules/`: home-grown modules for hacc-specific services
- `nix/`: sources files, managed with niv
- `pkgs/`: packages we built and don't want to upstream
## working with the haccfiles
deploy:
``` shell
nix build -f . deploy.$hostname && ./result switch
```
`$hostname` can be replaced with any hostname or group