all repos — scriptura @ fd61ac887fd4160094757c843ca55cbe1a49f552

a corner in $HOME for your scripts

document overlay and configuration

Alan Pearce
commit

fd61ac887fd4160094757c843ca55cbe1a49f552

parent

433782d3d494d65578347f0eb6f610e91bc49394

1 file changed, 21 insertions(+), 1 deletion(-)

changed files
M README.md → README.md
@@ -31,9 +31,29 @@ ```nix
 inputs.scriptura.url = "git+https://codeberg.org/alinnow/scriptura";
 ```
 
+Add the overlay:
+
 ```nix
-programs.script-directory.package = inputs.scriptura.packages.${system}.scriptura;
+overlays = [
+  scriptura.overlays.default
+]
 ```
+
+And then configure the script-directory module:
+
+```nix
+programs.script-directory = {
+  enable = true;
+  package = pkgs.scriptura
+  settings = {
+    SD_ROOT = "${config.home.homeDirectory}/.sd";
+    SD_EDITOR = "nvim";
+    SD_CAT = "lolcat"; 
+  };
+};
+```
+
+Any `SD_*` variables will be respected as long as their `SCRIPTURA_*` counterpart is not set.
 
 ### Manual Installation