docs: update dev setup.
This commit is contained in:
12
README.md
12
README.md
@@ -23,8 +23,10 @@ Welcome to `pyasic`! `pyasic` uses an asynchronous method of communicating with
|
|||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
It is recommended to install `pyasic` in a [virtual environment](https://realpython.com/python-virtual-environments-a-primer/#what-other-popular-options-exist-aside-from-venv) to isolate it from the rest of your system. Options include:
|
It is recommended to install `pyasic` in a [virtual environment](https://realpython.com/python-virtual-environments-a-primer/#what-other-popular-options-exist-aside-from-venv) to isolate it from the rest of your system. Options include:
|
||||||
- [pypoetry](https://python-poetry.org/)
|
- [pypoetry](https://python-poetry.org/): the reccommended way, since pyasic already uses it by default
|
||||||
`poetry install`
|
```
|
||||||
|
poetry install
|
||||||
|
```
|
||||||
- [venv](https://docs.python.org/3/library/venv.html): included in Python standard library but has fewer features than other options
|
- [venv](https://docs.python.org/3/library/venv.html): included in Python standard library but has fewer features than other options
|
||||||
- [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv): [pyenv](https://github.com/pyenv/pyenv) plugin for managing virtualenvs
|
- [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv): [pyenv](https://github.com/pyenv/pyenv) plugin for managing virtualenvs
|
||||||
```
|
```
|
||||||
@@ -39,8 +41,10 @@ It is recommended to install `pyasic` in a [virtual environment](https://realpyt
|
|||||||
`python -m pip install .` or `poetry install`
|
`python -m pip install .` or `poetry install`
|
||||||
|
|
||||||
##### Additional Developer Setup
|
##### Additional Developer Setup
|
||||||
`poetry install --with dev`
|
```
|
||||||
`pre-commit install`
|
poetry install --with dev
|
||||||
|
pre-commit install
|
||||||
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
## Getting started
|
## Getting started
|
||||||
|
|||||||
Reference in New Issue
Block a user