Update readme files
This commit is contained in:
@ -1 +1,36 @@
|
||||
# FairHopper Python SDK
|
||||
|
||||
Requirements:
|
||||
- Python 3.10+
|
||||
|
||||
## Setting up environment
|
||||
|
||||
Project uses [Poetry](https://python-poetry.org), ultimate dependency management software for Python.
|
||||
|
||||
Install Poetry:
|
||||
```sh
|
||||
pip install poetry
|
||||
```
|
||||
|
||||
Install virtual environment:
|
||||
```sh
|
||||
poetry install
|
||||
```
|
||||
|
||||
## Running demo
|
||||
|
||||
Check `demo.py` for usage example.
|
||||
|
||||
Edit `demo.py` and configure FairHopper Game host settings:
|
||||
|
||||
```python
|
||||
FAIRHOPPER_HOST = "http://127.0.0.1"
|
||||
FAIRHOPPER_PORT = 8010
|
||||
```
|
||||
|
||||
Activate environment and run example:
|
||||
|
||||
```sh
|
||||
poetry shell
|
||||
python demo.py
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user