diff --git a/README.md b/README.md index f220c7b7..412b7838 100644 --- a/README.md +++ b/README.md @@ -15,9 +15,31 @@ ![Architecture](./asset/hyperlane-all.png) -## Project Structure +## Prerequisites + +- rust (wasm32-wasm32-unknown target) +- go 1.20 or higher +- llvm-cov +## How to build + +```bash +make install-dev + +make build ``` + +## How to test + +```bash +cargo test --workspace --exclude hpl-tests + +cargo llvm-cov --workspace --exclude hpl-tests +``` + +## Project Structure + +```text ├── contracts │ │ │ ├── core @@ -67,25 +89,3 @@ └── ts └── sdk # typescript sdk for contract integration. (auto generated via ts-codegen) ``` - -## Prerequisites - -- rust (wasm32-wasm32-unknown target) -- go 1.20 or higher -- llvm-cov - -## How to build - -```bash -make install-dev - -make build -``` - -## How to test - -```bash -cargo test --workspace --exclude hpl-tests - -cargo llvm-cov --workspace --exclude hpl-tests -```