Skip to content

Commit 7bb72e2

Browse files
authored
Updated readme (#15)
* updated readme * added instructions for smplx installation
1 parent 48ba803 commit 7bb72e2

1 file changed

Lines changed: 71 additions & 0 deletions

File tree

README.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,74 @@
11
# SimplicityHL Standard Library
22

33
This repository contains the standard library for [SimplicityHL](https://github.com/BlockstreamResearch/SimplicityHL).
4+
5+
## Dev Info
6+
### Installation
7+
8+
> Project currently uses Simplex version 0.0.6.
9+
10+
To compile the project, execute the following command:
11+
12+
```bash
13+
cargo build
14+
```
15+
16+
To download simplexup, run:
17+
18+
```bash
19+
curl -L https://smplx.simplicity-lang.org | bash
20+
```
21+
22+
To install a specific Simplex version (in this case the v0.0.6 version):
23+
24+
```bash
25+
simplexup --install v0.0.6
26+
```
27+
28+
### Compilation
29+
30+
To compile the contracts, execute the following command:
31+
32+
```bash
33+
simplex build
34+
```
35+
36+
To clean up generated artifacts:
37+
38+
```bash
39+
simplex clean
40+
```
41+
42+
### Test
43+
44+
To run the tests with logs (`-v` or `-vv` is available), execute the following command:
45+
46+
```bash
47+
simplex test -v
48+
```
49+
50+
To run the tests using multiple threads:
51+
52+
```bash
53+
simplex test --test-threads 8
54+
```
55+
56+
To run a specific test:
57+
58+
```bash
59+
simplex test test_name
60+
```
61+
62+
### Linting
63+
64+
To format the rust files, execute the following command:
65+
66+
```bash
67+
cargo fmt
68+
```
69+
70+
To check the project for common mistakes:
71+
72+
```bash
73+
cargo clippy --workspace --all-targets --all-features -- -D warnings
74+
```

0 commit comments

Comments
 (0)