Skip to content
Snippets Groups Projects
Unverified Commit dc410508 authored by aalbert's avatar aalbert Committed by v-lafeychine
Browse files

Resolve "improve README" ✨️

Closes #37 🐔️👍️
Approved-by: default avataraalbert <augustin.albert@bleu-azure.fr>
Approved-by: default avatarbelazy <aarthuur01@gmail.com>
Approved-by: default avatarv-lafeychine <vincent.lafeychine@proton.me>

🦀️🍰🦀️🍰🦀️🍰

* add ?main

* nix run

* add backticks

* Apply 1 suggestion(s) to 1 file(s)

* fix links

* add blabla

* mermaid test

* mermaid test

* mermaid test
parent 1f0aa51e
No related branches found
No related tags found
No related merge requests found
......@@ -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;
```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment