From 675499f46d973d411b0760288da88b380569723b Mon Sep 17 00:00:00 2001 From: Luis Videla Date: Fri, 5 Apr 2024 11:27:31 -0300 Subject: [PATCH] chore: readme format --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 8fc65f9..a443acd 100644 --- a/README.md +++ b/README.md @@ -51,12 +51,14 @@ storage layout. **Getting Started** 1. Create a new directory: + ``` $ mkdir uniswap-v3-foundry $ cd uniswap-v3-foundry ``` 2. Initialize the project with the foundry-template: + ``` $ forge init --template PaulRBerg/foundry-template ``` @@ -69,21 +71,25 @@ storage layout. **Building and Testing** - Build the contracts: + ``` $ forge build ``` - Delete the build artifacts and cache directories: + ``` $ forge clean ``` - Get a test coverage report: + ``` $ forge coverage ``` - Run the tests: + ``` $ forge test $ forge test --match-path test/UniswapV3Swap.t.sol @@ -97,6 +103,7 @@ storage layout. **Deployment** - Deploy to testnet: + - Load the variables in the .env file: ``` $ source .env @@ -123,6 +130,7 @@ This project also utilizes the Solidity 2 UML tool available at ``` - To generate a class diagram: + ``` $ sol2uml class ./src/UniswapV3Swap.sol ```