Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
0xLucqs committed Aug 14, 2024
1 parent 81c3a1a commit 25ede7c
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,19 @@ To run the tests you'll need to provide the path to the cairo corelib (at some p
not there yet).

```sh
CORELIB_PATH="/path/to/corelibe" cargo test
CORELIB_PATH="/path/to/corelib/src" cargo test
```

### Cli instructions

To add a new test you can use the dev cli with:

```bash
cargo run --bin create_test <lint_name>
```

### Manual instructions

Each lint should have its own tests and should be extensive. To create a new test for a lint you need to create a file
in the [test_files folder](./crates/cairo-lint-core/tests/test_files/) and should be named as your lint. The file should
have this format:
Expand Down

0 comments on commit 25ede7c

Please sign in to comment.