diff --git a/README.md b/README.md index 6ad523e26a6c4bb30eb0959b0a895377698c4f7e..139aa4f9148ccdae66d8f85362af03c599c5981f 100644 --- a/README.md +++ b/README.md @@ -2,22 +2,27 @@ A simple proof assistant written in Rust. -The specification of the project may be found -[https://gitlab.crans.org/loutr/proost/-/blob/main/docs/specs.pdf](here). -The documentation, generated with `rust-doc` may be found -[https://perso.crans.org/v-lafeychine/proost/doc/proost/](here). +The specification of the project may be found [here](docs/specs.pdf). +The documentation, generated with `rust-doc` may be found [here](doc/proost/). -### Development environment -With `nix` installed, simply type `nix develop`. This provides an environment -with all the necessary tools, including `clippy` and `rustfmt`. There, it is -possible to run the usual `cargo build` and so on. +### Usage +Please see the specification for insights on how to use `proost` and `tilleul`. -Please consider the syntax `nix develop --profile <a-file-of-your-choosing>`, which -will prevent the garbage collection of the development dependencies. +### Build and install +With `nix` installed, simply type `nix run git+ssh://git@gitlab.crans.org/loutr/proost.git?ref=main` to launch `proost`. Alternatively, clone this git repository and type `nix build` to perform a build and have it in the nix store. One can also type `nix profile install` in the repo to install `proost` to one's profile and use it everywhere! +### Development environment +With `nix` installed, simply type `nix develop`. This provides an environment with all the necessary tools, including `clippy` and `rustfmt`. There, it is possible to run the usual `cargo build` and so on. -### Build and install -With `nix` installed, type `nix build` to perform a build and have it in the nix -store. One can also type `nix profile install` in the repo to install *proost* -to one's profile and use it everywhere! +Please consider the syntax `nix develop --profile <a-file-of-your-choosing>`, which will prevent the garbage collection of the development dependencies. + +### Crates dependencies +```mermaid +graph TD; + kernel-->tilleul; + kernel-->parser; + parser-->tilleul; + parser-->proost; + kernel-->proost; +```