bring readme up to date
This commit is contained in:
18
README.org
18
README.org
@@ -1,20 +1,4 @@
|
|||||||
#+title: Sydnix
|
#+title: Sydnix
|
||||||
#+author: Madeleine Sydney Ślaga
|
#+author: Madeleine Sydney Ślaga
|
||||||
|
|
||||||
Hello! These are my dotfiles for all my software and Nix machines. My TODO lists and READMEs tend to share a file, so I've moved it out of version-control. A link will be here soon enough.
|
these are my disgusting undocumented dotfiles. someday they'll be documented. maybe. }:)
|
||||||
|
|
||||||
* Overview
|
|
||||||
|
|
||||||
** Modules
|
|
||||||
|
|
||||||
Nix modules are Sydnix's primary mode of organisation. The modules in this repository are categorised by the scope of their applicability, be it user-specific, machine-specific, Sydnix-specific, or releasable. These sum of these categories resembles a hierarchy wherein modules become less generally-applicable as they build off one another. This all goes to say, in a very roundabout fashion, that we are using the [[https://www.nayuki.io/pe/designing-better-file-organization-around-tags-not-hierarchies][accursed]] hierarchical file-system as god intended:
|
|
||||||
|
|
||||||
#+begin_example
|
|
||||||
«TODO: Annotated diagram explaining the structore of modules/»
|
|
||||||
#+end_example
|
|
||||||
|
|
||||||
User modules may be configurations using a host-specific module, which itself may be a configuration of a Sydnix-specific module.
|
|
||||||
|
|
||||||
# Local Variables:
|
|
||||||
# jinx-local-words: "dotfiles"
|
|
||||||
# End:
|
|
||||||
|
|||||||
Reference in New Issue
Block a user