Merge pull request #69 from projectgus/tweak/optional_envrc

Pascal Hertleif · web-flow · commit bd6328315873 · 2024-05-07T14:01:39.000+02:00
meta: Rename .envrc for non-Nix users, add note in README
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-lorri b/envrc-lorri
