Skip to content

Commit 8e05bbb

Browse files
authored
Clarify devleopment setup in README
1 parent b3488bf commit 8e05bbb

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,22 @@
44
## Installation
55
`pip3 install running-ng`
66

7+
There are two [extras](https://peps.python.org/pep-0508/#extras) available.
8+
- `zulip`: dependencies for the `Zulip` `runbms` plugin, useful for users.
9+
- `tests`: dependencies for running tests, useful for package developers.
10+
711
## Development setup
8-
```console
12+
```bash
913
virtualenv env
1014
source env/bin/activate
11-
pip install -U pip setuptools build[virtualenv] twine
15+
pip install -e .[zulip,tests]
16+
pip install -U pip setuptools build[virtualenv] twine # extra packages for building releases
1217
```
1318

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

19-
There are two [extras](https://peps.python.org/pep-0508/#extras) available.
20-
- `zulip`: dependencies for the `Zulip` `runbms` plugin.
21-
- `tests`: dependencies for running tests.
22-
2323
## Documentation
2424
Please refer to [this site](https://anupli.github.io/running-ng/) for up-to-date documentations.
2525

0 commit comments

Comments
 (0)