From aa548f00743f8ea58f79a8dcfcaf93bee60394a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A1s=20Schmelczer?= Date: Fri, 15 Jul 2022 17:07:41 +0200 Subject: [PATCH] Improve layout --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b01d2d8..8e3b140 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ That's it. Your GreatAI service is _nearly_ ready for production use. Many of th ![scope of GreatAI](https://raw.githubusercontent.com/schmelczer/great-ai/main/docs/media/scope-simple.drawio.svg) -GreatAI fits between the prototype and deployment phases of your AI development lifecycle. This is highlighted with blue in the diagram. Here, a number of best practices can be automatically implemented aiming to achieve the following attributes: +GreatAI fits between the prototype and deployment phases of your AI development lifecycle. This is highlighted with blue in the diagram. Here, several best practices can be automatically implemented aiming to achieve the following attributes: - **G**eneral: use any Python library without restriction - **R**obust: have error-handling and well-tested utilities out-of-the-box @@ -82,14 +82,22 @@ pip install --upgrade flit pip flit install --symlink ``` -### Run tests +### Develop + +```sh +scripts/format-python.sh great_ai docs tests +``` + +> Format code. ```sh python3 -m pytest --doctest-modules --asyncio-mode=strict . ``` -### Serve documentation +> Run tests. ```sh mkdocs serve ``` + +> Serve documentation.