Skip to content

Commit

Permalink
Merge pull request #3 from chronicleprotocol/caloricity_2023-08-01T18…
Browse files Browse the repository at this point in the history
…-08-55Z

Doc fixup + deploy instructions
  • Loading branch information
jar-o authored Aug 3, 2023
2 parents 6e7a628 + 2082ad0 commit 512ddf0
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ The contract uses [`chronicle-std/Auth`](https://github.com/chronicleprotocol/ch
## Installation

Install module via Foundry:

```bash
$ forge install chronicleprotocol/greenhouse@v1
```
Expand All @@ -18,29 +19,43 @@ $ forge install chronicleprotocol/greenhouse@v1
The project uses the Foundry toolchain. You can find installation instructions [here](https://getfoundry.sh/).

Setup:

```bash
$ git clone https://github.com/chronicleprotocol/greenhouse
$ cd greenhouse
$ forge install
```

Run tests:

```bash
$ forge test
$ forge test -vvvv # Run with full stack traces
$ FOUNDRY_PROFILE=intense forge test # Run in intense mode
```

Lint:

```bash
$ forge fmt [--check]
```

Update gas snapshots:

```bash
$ forge snapshot [--check]
```

## Deploy

```
forge create --rpc-url $ETH_RPC_URL \
--private-key $YOUR_PRIVATE_KEY \
src/Greenhouse.sol:Greenhouse \
--constructor-args $AUTHED_DEPLOYER \
--verify
```

## Dependencies

- [chronicleprotocol/chronicle-std@v2](https://github.com/chronicleprotocol/chronicle-std/tree/v2)

0 comments on commit 512ddf0

Please sign in to comment.