docs(readme): update readme
added installation, building, and contribution details to the readme
This commit is contained in:
1 file changed
+15
@@ -30,3 +30,18 @@ $ mcl
|
|||||||
```
|
```
|
||||||
|
|
||||||
for full usage, see `mcl -h`
|
for full usage, see `mcl -h`
|
||||||
|
|
||||||
|
## installation
|
||||||
|
install using cargo.
|
||||||
|
```sh
|
||||||
|
cargo install --git https://git.ozzy.top/ozzy/mcl
|
||||||
|
```
|
||||||
|
|
||||||
|
## building
|
||||||
|
build using `just`. see available recipes by running `just` or `just --list`.
|
||||||
|
|
||||||
|
## contribution
|
||||||
|
before contributing, make sure all tests pass. also make sure to add tests for any new features.
|
||||||
|
```sh
|
||||||
|
just test
|
||||||
|
```
|
||||||
Reference in new issue
Block a user