From f48f4afc71316597280277b4bc0a66200f45efa5 Mon Sep 17 00:00:00 2001 From: mike Date: Fri, 9 Sep 2022 08:50:03 +0200 Subject: [PATCH] readme updates (#98) --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c6b0d78..29f369d 100644 --- a/README.md +++ b/README.md @@ -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 ```