Skip to content

Commit

Permalink
chore: readme format
Browse files Browse the repository at this point in the history
  • Loading branch information
luisvid committed Apr 5, 2024
1 parent 61fd0e0 commit 675499f
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand All @@ -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
Expand All @@ -97,6 +103,7 @@ storage layout.
**Deployment**

- Deploy to testnet:

- Load the variables in the .env file:
```
$ source .env
Expand All @@ -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
```
Expand Down

0 comments on commit 675499f

Please sign in to comment.