Skip to content

Commit

Permalink
Clarify devleopment setup in README
Browse files Browse the repository at this point in the history
  • Loading branch information
caizixian authored Jul 22, 2024
1 parent b3488bf commit 8e05bbb
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,22 @@
## Installation
`pip3 install running-ng`

There are two [extras](https://peps.python.org/pep-0508/#extras) available.
- `zulip`: dependencies for the `Zulip` `runbms` plugin, useful for users.
- `tests`: dependencies for running tests, useful for package developers.

## Development setup
```console
```bash
virtualenv env
source env/bin/activate
pip install -U pip setuptools build[virtualenv] twine
pip install -e .[zulip,tests]
pip install -U pip setuptools build[virtualenv] twine # extra packages for building releases
```

- To make a distribution archives, run `python -m build` within the virtual environment.
- To run an editable build in the virtual environment, run `pip install -e .`.
- To install to user `site-packages`, run `pip install dist/running_ng-<VERSION>-py3-none-any.whl` outside the virtual environment.
- To update to PyPI, run `twine upload --repository running-ng dist/*<VERSION>*`.

There are two [extras](https://peps.python.org/pep-0508/#extras) available.
- `zulip`: dependencies for the `Zulip` `runbms` plugin.
- `tests`: dependencies for running tests.

## Documentation
Please refer to [this site](https://anupli.github.io/running-ng/) for up-to-date documentations.

Expand Down

0 comments on commit 8e05bbb

Please sign in to comment.