chore: update readme

sentimentxyz · Aug 27, 2022 · a2ddbcc · a2ddbcc
1 parent 67d0ee4
commit a2ddbcc
Showing 1 changed file with 43 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,2 +1,44 @@
-# controller
+# Controller
+
 Interaction Controller For Sentiment
+
+## Instructions
+
+### Requirements
+
+1. Rust
+2. Foundry - https://github.com/gakonst/foundry
+
+---
+
+### Cloning Repo
+
+```bash
+git clone --recurse-submodules [email protected]:sentimentxyz/controller.git
+```
+
+---
+
+### Building Contracts
+
+```bash
+forge build
+```
+
+---
+
+### Running tests
+
+#### Unit/Functional tests
+
+```bash
+forge test --fork-url https://rpc.ankr.com/eth  -vvv
+```
+
+---
+
+#### Configuring mappings
+
+```bash
+forge config > remappings.txt
+```