Documenting first time running the custom pool

Author: joaobrunoah

README.md

@@ -2,4 +2,16 @@
 
 Example of external custom pool for Balancer V3. Extend it to create new pool types.
 
-forge install && yarn && cd lib/balancer-v3-monorepo && yarn && yarn build && cd ../.. && yarn build && yarn test:hardhat
+# Requirements
+
+- Node.js v18.x (we recommend using nvm to install it)
+- Yarn v4.x
+- Foundry v1.0.0
+
+# Installation
+
+If it's the first time running the project, run `yarn install-fresh` to install the dependencies and build the project. It'll download and compile V3 monorepo, creating node_modules folders in the library (these folders will be needed to use monorepo as a submodule of the custom pool, so tests can use the base test files).
+
+# Testing
+
+After installing the dependencies, run `yarn test` to run forge and hardhat tests.

package.json

@@ -17,6 +17,7 @@
     "Elshan Dzhafarov <[email protected]>"
   ],
   "scripts": {
+    "install-fresh": "sh ./scripts/install-fresh.sh",
     "build": "yarn workspaces foreach --parallel --jobs unlimited --verbose run build && yarn compile && rm -rf artifacts/build-info",
     "compile": "hardhat compile",
     "compile:watch": "nodemon --ext sol --exec yarn compile",

scripts/install-fresh.sh

@@ -0,0 +1,7 @@
+forge install
+yarn
+cd lib/balancer-v3-monorepo
+yarn
+yarn build
+cd ../..
+yarn build