config.md: Add some config key descriptions

myme · May 13, 2024 · ae407ce · ae407ce
1 parent 56c2e5f
commit ae407ce
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/extra/config.md b/extra/config.md
@@ -5,12 +5,23 @@
 The following source code block defines a `nixon` configuration using `YAML`:
 
 ``` yaml config
+# Enable "exact" matching algorithm.
 exact_match: true
+
+# Ignore case by default.
 ignore_case: true
+
+# Evaluate direnv environments.
 use_direnv: true
+
+# Evaluate nix shell environments.
 use_nix: true
+
+# Location of project directories.
 project_dirs:
   - ~/src
+
+# Project types, with marker file detection.
 project_types:
   - name: cabal
     test: ["cabal.project"]