From 9acfcd7f8a03e95d10d9322d9e05e34c1220424a Mon Sep 17 00:00:00 2001 From: aalbert <augustin.albert@bleu-azure.fr> Date: Sat, 26 Nov 2022 15:17:52 +0100 Subject: [PATCH] =?UTF-8?q?Resolve=20"improve=20README"=20=E2=9C=A8?= =?UTF-8?q?=EF=B8=8F=20Closes=20#37=20=F0=9F=90=94=EF=B8=8F=F0=9F=91=8D?= =?UTF-8?q?=EF=B8=8F=20Approved-by:=20aalbert=20<augustin.albert@bleu-azur?= =?UTF-8?q?e.fr>=20Approved-by:=20belazy=20<aarthuur01@gmail.com>=20Approv?= =?UTF-8?q?ed-by:=20v-lafeychine=20<vincent.lafeychine@proton.me>?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 🦀ï¸ðŸ°ðŸ¦€ï¸ðŸ°ðŸ¦€ï¸ðŸ° * add ?main * nix run * add backticks * Apply 1 suggestion(s) to 1 file(s) * fix links * add blabla * mermaid test * mermaid test * mermaid test --- README.md | 33 +++++++++++++++++++-------------- 1 file changed, 19 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 6ad523e2..139aa4f9 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; +``` -- GitLab