Merge pull request #69 from projectgus/tweak/optional_envrc

meta: Rename .envrc for non-Nix users, add note in README
technocreatives · May 7, 2024 · bd63283 · bd63283
2 parents 62d325a + 41ba2b2
commit bd63283
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
-target
+target
+.envrc
diff --git a/README.md b/README.md
@@ -131,6 +131,16 @@ pub fn xtype(&self) -> BarType {
 }
 ```
 
+## Development
+
+### lorri for Nix
+
+If using Nix, dbc-codegen is integrated with [lorri](https://github.com/nix-community/lorri) for easy project dependency management. To enable, create a symlink in the top-level working directory:
+
+```sh
+ln -s envrc.lorri .envrc
+```
+
 ## License
 
 Licensed under either of

diff --git a/.envrc → envrc-lorri b/.envrc → envrc-lorri
-Original file line number
+Diff line change
@@ -1 +1,2 @@
-    target
+    target
+    .envrc