From 7b171a7b588e4d9ddba10dd11d9f508aa0980186 Mon Sep 17 00:00:00 2001 From: Lukas Grossberger Date: Sat, 26 Jun 2021 23:28:48 +0200 Subject: [PATCH] update instructions for build dependencies * typo in sphinx plantuml package name * make python and system dependencies explicit --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 93e6e0c..b41eec5 100644 --- a/README.md +++ b/README.md @@ -24,10 +24,13 @@ TBD ## Building -building the ki-doku depends on python, sphinx, -sphinx-contrib-plantuml und plantuml. +Building the ki-doku depends on the following Python packages: +* `sphinx` +* `sphinxcontrib-plantuml` -building/ using the ki-backend depends on python and flask. +as well as the system dependency `plantuml`, which you can get e.g. with `apt install plantuml` + +Building/using the ki-backend depends on python and flask, see the repo's environment specification for details. ## Roadmap