diff --git a/README.md b/README.md index f29ea14..e8a7114 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,40 @@ # SimplicityHL Standard Library This repository contains the standard library for [SimplicityHL](https://github.com/BlockstreamResearch/SimplicityHL). + +## Dev Info +### Compilation + +To compile the project, execute the following command: + +```bash +cargo build +``` + +To compile the contracts, execute the following command: + +```bash +simplex build +``` + +### Test + +To run the tests, execute the following command: + +```bash +simplex test -v +``` + +### Linting + +To format the rust files, execute the following command: + +```bash +cargo fmt +``` + +To check the project for common mistakes, execute the following command: + +```bash +cargo clippy --workspace --all-targets --all-features -- -D warnings +```