diff --git a/README.md b/README.md new file mode 100644 index 0000000..c82aac5 --- /dev/null +++ b/README.md @@ -0,0 +1,69 @@ +
+ +# rustyCTBN + +
+ +## 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 +```