Skip to content

Commit

Permalink
Readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jun 5, 2024
1 parent dd94c69 commit 26d65c5
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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](https://github.com/hacspec/hax/examples/): the [examples directory](./examples/) contains
- [Examples](https://github.com/hacspec/hax/tree/main/examples/): the [examples directory](./examples/) contains
a set of examples that show what hax can do for you.

## Usage
Expand Down Expand Up @@ -57,7 +57,7 @@ Note:
- [`jq`](https://jqlang.github.io/jq/)

2. Clone this repo: `git clone [email protected]:hacspec/hax.git && cd hax`
3. Run the [setup.sh](https://github.com/hacspec/hax/setup.sh) script: `./setup.sh`.
3. Run the [setup.sh](https://github.com/hacspec/hax/tree/main/setup.sh) script: `./setup.sh`.
4. Run `cargo-hax --help`

</details>
Expand Down Expand Up @@ -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`](https://github.com/hacspec/hax/.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/tree/main/.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`).
Expand Down

0 comments on commit 26d65c5

Please sign in to comment.