commit f58e8363956a94db414cfae349698135097b01b6
parent bcace06b7ce1d8fda9229b9d3f7ca5bd5faf55f3
Author: Vincent Demeester <vincent@sbr.pm>
Date: Mon, 16 Mar 2020 17:37:35 +0100
Update README.org with more details
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Diffstat:
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/README.org b/README.org
@@ -74,8 +74,12 @@
soon-ish 👼):
- ~assets~: ignored folder where my /automation/ puts some /secrets/.
-- ~docs~: holds documentation about this code, literate configuration.
-- ~lib~: shared code used during configuration (mostly ~nix~ code), see [[literate configuration][literate configuration]].
+ Most of the =make= commands will try to populate this ahead of time. The assumption is :
+ have a ~sync~ folder where the assets are. /Note: how to bootstrap (as syncthing will
+ not be there, and the ~sync~ folder either)/
+- ~docs~: holds documentation about this code, literate configuration, see [[literate configuration][literate configuration]].
+ =make publish= will publish the =README.org= and the =docs= folder to my website.
+- ~lib~: shared code used during configuration (mostly ~nix~ code).
- ~machines~: configuration per machines
- ~modules~: holds nix modules (services, programs, hardware, profiles, …)
- ~overlays~: holds [[https://nixos.wiki/wiki/Overlays][nix overlays]]
@@ -87,10 +91,6 @@
in order to end up with one huge file. The goal of having those =org-mode= files, is
mainly to document my configuration and publish it, most likely on [[https://sbr.pm][sbr.pm]].
-Let's start by having =org-mode= files in the root folder.
-- [[./mails.org][=mails.org=]] holds mail configuration, that becomes more or less the ~profiles.mail~
- configuration
-
* References
:PROPERTIES:
:CUSTOM_ID: h:e5a95a68-f031-438b-831c-824803d0bc3e
