From 494eb311b20e7a67957a71e8e744be6bff641c26 Mon Sep 17 00:00:00 2001 From: Guilhem Bonnefille Date: Wed, 29 Jul 2020 22:59:22 +0200 Subject: [PATCH] Document usage of project --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 569d5d7..a5d9f84 100644 --- a/README.md +++ b/README.md @@ -1 +1,13 @@ An OpenAPI description of OpenKarotzAPI. + +# Build + +Use Makefile to: + +1. download Swagger utility +2. generate documentation: `make doc` +3. generate python API client: `make python` + +# Usage/Test + +You can test the python API client with `test_python.py` example.