Skip to content

Commit

Permalink
readme updates (#98)
Browse files Browse the repository at this point in the history
  • Loading branch information
mshrieve authored Sep 9, 2022
1 parent 0717812 commit f48f4af
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,26 +23,35 @@ To install dependences:
pnpm i
```

For submodules:
To install submodules:

```[bash]
forge update
forge install
```

For some scripts, you might need `jq` JSON utility. To install on MacOS, run `brew install jq`.
For some scripts, you will need the `jq` JSON utility. To install on MacOS, run `brew install jq`.

---

### Test

To run forge tests:

```[bash]
pnpm test
forge test
```

---

### Bibos Local Inspector

The Bibos Local Inspector is a local web interface which allows you to:

- generate and view random Bibos from the contract
- inspect the underlying SVG code

To use:

```[bash]
pnpm dev
```

0 comments on commit f48f4af

Please sign in to comment.