Skip to content

Commit

Permalink
DOC: Add ruff note in development section
Browse files Browse the repository at this point in the history
  • Loading branch information
jvkersch committed Jul 20, 2024
1 parent 940eb23 commit bbcb964
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,6 @@ running
Pre-built wheels are available for Linux, macOS, and Windows, for Python 3.6
and up.

To build the package from scratch, e.g. because you want to contribute to it,
clone this repository, and then from the root of the repository, run
```console
pip install -e . -v
```
This requires a C++ compiler to be installed with support for C++ 14.

Usage
-----
Expand Down Expand Up @@ -82,6 +76,22 @@ biopython`). Then run:
(147, 3)
```

Development mode
----------------

To build the package from scratch, e.g. because you want to contribute to it,
clone this repository, and then from the root of the repository, run
```console
pip install -e . -v
```
This requires a C++ compiler to be installed with support for C++ 14.

This project uses [ruff](https://docs.astral.sh/ruff/) as a code formatter and
linter. Ruff is run automatically via GitHub actions on new commits, please
consider running locally (preferably via a pre-commit hook) to notice and fix
any errors early on.


Running the tests
-----------------

Expand Down

0 comments on commit bbcb964

Please sign in to comment.