From a125cc339689da141dac6446e4ca5fa1132c272b Mon Sep 17 00:00:00 2001 From: Timothy DeHerrera Date: Fri, 3 Jan 2020 17:05:26 -0700 Subject: [PATCH] README.md: expand on aim, and explain secrets --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ada481c1..281432eb 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ # Introduction This project is under construction as a rewrite of my [legacy][old] -NixOS configuration, using the experimental [flakes][rfc] mechanism. +NixOS configuration, using the experimental [flakes][rfc] mechanism. Its aim is +to provide a generic template repository, to neatly separate concerns and allow +one to get up and running with NixOS faster. Flakes are still an experimental +feature, but once they finally get merged, even more will become possible, +including nixops support. #### [Flake Talk][video] @@ -64,6 +68,15 @@ User declaration belongs in the [users](users) directory. Everything related to your user should be declared here. For convenience, [home-manager][home-manager] is available automatically for home directory setup. +## Secrets +Anything you wish to keep encrypted goes in the [secrets](secrets) directory. +Be sure to run `git-crypt init`, before committing anything to this repo. +Be sure to check out the [documentation](https://github.com/AGWA/git-crypt) if +your not familiar. + +To keep [profiles](profiles) resuable across configurations, secrets should +only be imported from the [users](users) directory. + ## Modules and Packages All [modules](modules/default.nix) and [pkgs](pkgs/default.nix) are available for every configuration automatically. Simply add a `*.nix` file to one of