Update readme
This commit is contained in:
@ -5,6 +5,8 @@ Requirements:
|
||||
|
||||
## Setting up environment
|
||||
|
||||
### Recommended: Using Poetry
|
||||
|
||||
Project uses [Poetry](https://python-poetry.org), ultimate dependency management software for Python.
|
||||
|
||||
Install Poetry:
|
||||
@ -17,6 +19,23 @@ Install virtual environment:
|
||||
poetry install
|
||||
```
|
||||
|
||||
### Simple: Using virtualenv
|
||||
|
||||
Create virtual environment:
|
||||
```sh
|
||||
virtualenv .env
|
||||
```
|
||||
|
||||
Activate virtual environment:
|
||||
```sh
|
||||
source .env/bin/activate
|
||||
```
|
||||
|
||||
Install required dependencies:
|
||||
```sh
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
## Running demo
|
||||
|
||||
Check `demo.py` for usage example.
|
||||
@ -29,7 +48,15 @@ FAIRHOPPER_HOST = "http://127.0.0.1:8010"
|
||||
|
||||
Activate environment and run example:
|
||||
|
||||
### Poetry
|
||||
|
||||
```sh
|
||||
poetry shell
|
||||
python demo.py
|
||||
```
|
||||
|
||||
### Virtualenv
|
||||
```sh
|
||||
source .env/bin/activate
|
||||
python demo.py
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user