Fix dev instructions

This commit is contained in:
Andras Schmelczer 2022-07-15 17:01:16 +02:00
parent 2d35bb1f70
commit 4debf1cf93
No known key found for this signature in database
GPG key ID: 39260B5B0614A13E

View file

@ -1,4 +1,5 @@
# <img src="https://raw.githubusercontent.com/schmelczer/great-ai/main/docs/media/logo.png" alt="logo of great-ai" width=60 /> GreatAI
> Easily transform your prototype AI code into production-ready software.
[![PyPI version](https://badge.fury.io/py/great-ai.svg)](https://badge.fury.io/py/great-ai)
@ -30,7 +31,7 @@ Start it by executing `great-ai demo.py`, find the dashboard at [http://localhos
![demo screen capture](https://raw.githubusercontent.com/schmelczer/great-ai/main/docs/media/demo.gif)
That's it. Your GreatAI service is *nearly* ready for production use. Many of the [SE4ML best-practices](https://se-ml.github.io) are configured and implemented automatically (of course, these can be customised as well).
That's it. Your GreatAI service is _nearly_ ready for production use. Many of the [SE4ML best-practices](https://se-ml.github.io) are configured and implemented automatically (of course, these can be customised as well).
[Check out the full documentation here](https://great-ai.scoutinscience.com).
@ -77,14 +78,14 @@ Contributions are welcome.
```sh
python3 -m venv --copies .env
source .env/bin/activate
pip install flit
flit install --symlink --deps=all
pip install --upgrade flit pip
flit install --symlink
```
### Run tests
```sh
pytest --doctest-modules --asyncio-mode=strict
python3 -m pytest --doctest-modules --asyncio-mode=strict .
```
### Serve documentation