From f5f190abd9eef15316ea92fe6ec42e1abc3bf6ca Mon Sep 17 00:00:00 2001 From: Théo de la Hogue Date: Tue, 8 Nov 2022 14:56:31 +0100 Subject: Adding wiki link. --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 55c7481..097aab0 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,18 @@ pip install -e . ## Documentation -To generate html documentation using [pdoc](https://pdoc.dev/), +### Wiki + +The [wiki](https://git.recherche.enac.fr/projects/argaze/wiki) provides many explanations about how works ArGaze, what is possible to do and code samples. + +### Cookbook + +The **utils** submodule is a good place to get ready made code examples. + +### Code + +ArGaze code documentation is based on [pdoc](https://pdoc.dev/). +To generate html documentation: - Install 'pdoc' package: -- cgit v1.1