Update nix documentation the README (#22)

input-output-hk · Nov 17, 2023 · 55370f9 · 55370f9
1 parent bfb2820
commit 55370f9
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -50,6 +50,14 @@ To get the dApp up and running on your local machine, follow these steps:
    ```bash
    npm run start
 
+## Development with Nix
+
+This repository uses nix to provide the development and build environment.
+
+For instructions on how to install and configure nix (including how to enable access to our binary caches), refer to [this document](https://github.com/input-output-hk/iogx/blob/main/doc/nix-setup-guide.md). 
+
+If you already have nix installed and configured, you may enter the development shell by running `nix develop`.
+
 ## Generating Payouts for Testing
 
 To generate payouts for testing purposes on the preprod and preview networks, we recommend using the **Marlowe Starter Kit**. The starter kit provides comprehensive instructions and tools, including Jupyter notebooks, to help you understand and work with Marlowe contracts.

diff --git a/flake.lock b/flake.lock