Added README with instructions to set and run a dev environmet

pull/18/head
Meliurwen 3 years ago
parent 9a27d794fc
commit a55675f6ce
Signed by: meliurwen
GPG Key ID: 818A8B35E9F1CE10
  1. 69
      README.md

@ -0,0 +1,69 @@
<div align="center">
# rustyCTBN
</div>
## App
> **Note:** At the moment it's in pre-alpha state.
A Continuous Time Bayesian Networks Liberary written in Rust. 🦀
### From Source
**Prerequisites:**
+ `rust`
**Install:**
At the _root_ of the project's folder launch:
```sh
cargo install --locked --path .
```
**Uninstall:**
Anywhere in the system launch:
```sh
cargo uninstall rustyCTBN
```
**Upgrade:**
At the _root_ of the project's folder launch:
```sh
cargo install --force --locked --path .
```
## Develop
**Prerequisites:**
+ `rust`
_Prepare_ the development environment:
```sh
cargo build
```
That's all! ☕
## Testing & Linting
To launch **tests**:
```sh
cargo test --locked
```
To **lint**:
```sh
cargo check --locked
```
Loading…
Cancel
Save