Skip to content

Commit

Permalink
Update development setup documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
caizixian committed May 23, 2024
1 parent 18b958c commit b5f6b6a
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,13 @@
```console
virtualenv env
source env/bin/activate
pip install -U pip setuptools build[virtualenv]
pip install -U pip setuptools build[virtualenv] twine
```

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 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.
Expand Down

0 comments on commit b5f6b6a

Please sign in to comment.