From 2cd7937788d92b1563d331dc428e29fa6644faeb Mon Sep 17 00:00:00 2001 From: aritkulova Date: Thu, 11 Jun 2026 19:44:44 +0300 Subject: [PATCH 1/2] updated readme --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) 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 +``` From fcb85da4feace1309394cdc765fa4aab100bda4a Mon Sep 17 00:00:00 2001 From: aritkulova Date: Tue, 23 Jun 2026 18:14:42 +0300 Subject: [PATCH 2/2] added instructions for smplx installation --- README.md | 40 +++++++++++++++++++++++++++++++++++++--- 1 file changed, 37 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e8a7114..8e198c8 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,9 @@ This repository contains the standard library for [SimplicityHL](https://github.com/BlockstreamResearch/SimplicityHL). ## Dev Info -### Compilation +### Installation + +> Project currently uses Simplex version 0.0.6. To compile the project, execute the following command: @@ -11,20 +13,52 @@ To compile the project, execute the following command: cargo build ``` +To download simplexup, run: + +```bash +curl -L https://smplx.simplicity-lang.org | bash +``` + +To install a specific Simplex version (in this case the v0.0.6 version): + +```bash +simplexup --install v0.0.6 +``` + +### Compilation + To compile the contracts, execute the following command: ```bash simplex build ``` +To clean up generated artifacts: + +```bash +simplex clean +``` + ### Test -To run the tests, execute the following command: +To run the tests with logs (`-v` or `-vv` is available), execute the following command: ```bash simplex test -v ``` +To run the tests using multiple threads: + +```bash +simplex test --test-threads 8 +``` + +To run a specific test: + +```bash +simplex test test_name +``` + ### Linting To format the rust files, execute the following command: @@ -33,7 +67,7 @@ To format the rust files, execute the following command: cargo fmt ``` -To check the project for common mistakes, execute the following command: +To check the project for common mistakes: ```bash cargo clippy --workspace --all-targets --all-features -- -D warnings