Skip to content

Commit

Permalink
Document important dev commands
Browse files Browse the repository at this point in the history
  • Loading branch information
chmp committed Oct 9, 2024
1 parent 27c85fe commit 767841f
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,17 @@
interface. The motivation behind `marrow` is to allow libraries to target multiple different arrow
versions simultaneously.

## Development

All important development tasks are packaged in the `x.py` script. It does not require any external
dependencies and can be executed with any recent Python version.

- `python x.py precommit`: wrapper around `format`, `check`, `test`
- `python x.py test`: execute the tests
- `python x.py check`: run linters
- `python x.py format`: format the source code
- `cargo test --all-features` execute the tests without the `x.py` script

## License

```text
Expand Down

0 comments on commit 767841f

Please sign in to comment.