Skip to content

Commit

Permalink
fix: broken links README.md (#1639)
Browse files Browse the repository at this point in the history
## Description
This PR fixes broken links in the `README.md` file to ensure all
references point to the correct resources.

## Time spent on this PR
0.2 days

## Pull request type
Please check the type of change your PR introduces:
- [x] Bugfix
- [ ] Feature
- [ ] Code style update (formatting, renaming)
- [ ] Refactoring (no functional changes, no api changes)
- [ ] Build related changes
- [ ] Documentation content changes
- [ ] Other (please describe):

## Current behavior
Currently, some links in the `README.md` are outdated or broken, causing
navigation issues for readers.

Resolves: No linked issue

## New behavior
- Updated the precompiles link to point to the correct
`cairo-precompiles` page.
- Fixed the test RLP library link to use the correct relative path.
- Updated the deploy script link to point to the correct file location.

---------

Co-authored-by: Clément Walter <[email protected]>
  • Loading branch information
cypherpepe and ClementWalter authored Nov 29, 2024
1 parent 830658f commit 306d391
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ future of zero-knowledge.
## Supported opcodes

We support 100% of EVM opcodes and
[9 out of 10 precompiles](https://docs.kakarot.org/starknet/architecture/differences).
[9 out of 10 precompiles](https://docs.kakarot.org/starknet/architecture/cairo-precompiles).

## Documentation

Expand Down Expand Up @@ -176,8 +176,8 @@ required. Actually, for tests requiring a Starknet devnet, prefer end-to-end
relying only on a RPC endpoint and currently running on Katana.

For an example of the cairo test runner, see for example
[the RLP library tests](tests/src/utils/test_rlp.py). Especially, the cairo
runner uses hints to communicate values and return outputs:
[the RLP library tests](./cairo_zero/tests/src/utils/test_rlp.py). Especially,
the cairo runner uses hints to communicate values and return outputs:

- `kwargs` of `cairo_run` are available in the `program_input` variable
- values written in the `output_ptr` segment are returned, e.g.
Expand Down Expand Up @@ -240,9 +240,10 @@ Note that the chosen `chain_id` when deploying is important:
- To be compatible with ledger the chain id needs to be inferior to 4 bytes see
https://github.com/kkrt-labs/kakarot/issues/1530

The [deploy script](./kakarot_scripts/deploy_kakarot.py) relies on some env
variables defined in a `.env` file located at the root of the project and loaded
in the [constant file](./kakarot_scripts/constants.py). To get started, just
The [deploy script](./kakarot_scripts/deployment/kakarot_deployment.py) relies
on some env variables defined in a `.env` file located at the root of the
project and loaded in the [constant file](./kakarot_scripts/constants.py). To
get started, just

```bash
cp .env.example .env
Expand Down

0 comments on commit 306d391

Please sign in to comment.