Update README.md
This commit is contained in:
12
README.md
12
README.md
@@ -10,18 +10,18 @@ do an [editable install](https://pip.pypa.io/en/stable/topics/local-project-inst
|
|||||||
in a [virtual environment](https://docs.python.org/3/library/venv.html).
|
in a [virtual environment](https://docs.python.org/3/library/venv.html).
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
git clone https://git.squad51.us/jamie/ucsinfer.git
|
$ git clone https://git.squad51.us/jamie/ucsinfer.git
|
||||||
git submodule sync
|
$ git submodule sync
|
||||||
python -m venv .venv
|
$ python -m venv .venv
|
||||||
source .venv/bin/activate # or whatever command is approprate for your shell
|
$ source .venv/bin/activate # or whatever command is approprate for your shell
|
||||||
pip install -e .
|
$ pip install -e .
|
||||||
```
|
```
|
||||||
|
|
||||||
Or alternately, this module is packaged with the [poetry][py-poetry] dependency
|
Or alternately, this module is packaged with the [poetry][py-poetry] dependency
|
||||||
manager and can be run within a poetry virtualenv.
|
manager and can be run within a poetry virtualenv.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
poetry run python -m ucsinfer
|
$ poetry run python -m ucsinfer
|
||||||
```
|
```
|
||||||
|
|
||||||
[py-poetry]: https://python-poetry.org/docs/1.8/cli/#run$0
|
[py-poetry]: https://python-poetry.org/docs/1.8/cli/#run$0
|
||||||
|
Reference in New Issue
Block a user