docs/examples: talking about cwd

nix-community · Jul 10, 2023 · 59cb08b · 59cb08b
1 parent 0d57fd2
commit 59cb08b
Showing 1 changed file with 26 additions and 0 deletions.
diff --git a/docs/examples/README.md b/docs/examples/README.md
@@ -0,0 +1,26 @@
+# Configuration Examples
+
+These are examples of `.nixd.json` of some scenarios.
+
+**Note: .nixd.json must be the working directory of nixd process.**
+
+i.e.
+
+For vim users:
+
+do not:
+
+```
+vi nixd/docs/examples/options/nixos/module.nix
+```
+
+instead:
+
+```
+cd nixd/docs/examples/options/nixos
+vi module.nix
+```
+
+For vscode users: please open each folder as your "workspace".
+
+