diff --git a/README.md b/README.md index 14abce4f2..ea5591066 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,11 @@ +
+ 🌐 Website | + 📖 Book | + 📝 Blog | + 💬 Zulip | + 🛠️ Internal docs +
+ # Hax hax is a tool for high assurance translations that translates a large subset of @@ -12,6 +20,15 @@ standard library, to write succinct, executable, and verifiable specifications i Rust. These specifications can be translated into formal languages with hax. +## Learn more + +Here are some resources for learning more about hax: + - [Book](https://hacspec.org/book) (work in progress) + + [Quick start](https://hacspec.org/book/quick_start/intro.html) + + [Tutorial](https://hacspec.org/book/tutorial/index.html) + - [Examples](examples/): the [examples directory](examples/) contains + a set of examples that show what hax can do for you. + ## Usage Hax is a cargo subcommand. The command `cargo hax` accepts the following subcommands: @@ -19,8 +36,8 @@ The command `cargo hax` accepts the following subcommands: * **`json`** (`cargo hax json`): extract the typed AST of your crate as a JSON file. Note: - * `BACKEND` can be `fstar`, `coq` or `easycrypt`. `cargo hax into - --help` gives the full list of supported backends. + * `BACKEND` can be `fstar`, `coq`, `easycrypt` or `pro-verif`. `cargo hax into --help` + gives the full list of supported backends. * The subcommands `cargo hax`, `cargo hax into` and `cargo hax into