From dd94c69b7372015e7a8c5d1397536fcc4f26f48b Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 5 Jun 2024 16:10:46 +0000 Subject: [PATCH] Readme update --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f12421c..8228a60 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ 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 + - [Examples](https://github.com/hacspec/hax/examples/): the [examples directory](./examples/) contains a set of examples that show what hax can do for you. ## Usage @@ -57,7 +57,7 @@ Note: - [`jq`](https://jqlang.github.io/jq/) 2. Clone this repo: `git clone git@github.com:hacspec/hax.git && cd hax` -3. Run the [setup.sh](./setup.sh) script: `./setup.sh`. +3. Run the [setup.sh](https://github.com/hacspec/hax/setup.sh) script: `./setup.sh`. 4. Run `cargo-hax --help` @@ -129,7 +129,7 @@ You can also just use [direnv](https://github.com/nix-community/nix-direnv), wit - `cli/`: the `hax` subcommand for Cargo. ### Recompiling -You can use the [`.utils/rebuild.sh`](./.utils/rebuild.sh) script (which is available automatically as the command `rebuild` when using the Nix devshell): +You can use the [`.utils/rebuild.sh`](https://github.com/hacspec/hax/.utils/rebuild.sh) script (which is available automatically as the command `rebuild` when using the Nix devshell): - `rebuild`: rebuild the Rust then the OCaml part; - `rebuild TARGET`: rebuild the `TARGET` part (`TARGET` is either `rust` or `ocaml`).