create readme

This commit is contained in:
atagen 2025-07-21 14:50:01 +10:00
parent 58479c6252
commit b5dfc0ffa1

19
README.md Normal file
View file

@ -0,0 +1,19 @@
# a nixos config
## mission statement
this config attempts to follow the [synaptic standard](https://github.com/llakala/synaptic-standard/), and is built in an effort to achieve **semantic colocation**.
ideally, our modules are categorised by the purpose they hope to fulfil, and contain all the information necessary to achieve that within their context.
this is in contrast to many configuration styles, which may be structured in a way that is beholden to mechanical details (programs, implementations, module systems, or other scope they may carry).
here, *we do not build our dreams of concrete*.
## mechanism
recursive imports and module aliasing bend the module system/s to our will.
this allows us to create freeform sets of modules which break down broad goals into manageable units while cross-cutting module system concerns, all with a single toplevel import point.
you can see [entry.nix](./entry.nix) and [util/create.nix](util/create.nix) for the explicit details of how this is done.