From f196ceaf49d614467b17c139d8e0f0f29a231877 Mon Sep 17 00:00:00 2001 From: Paul Harrison Date: Tue, 25 Jun 2024 10:58:14 +0100 Subject: [PATCH] make clearer how to install with requirements also show how plantuml is integrated --- README.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 8c5ff38..181398c 100644 --- a/README.md +++ b/README.md @@ -2,25 +2,23 @@ This **Polaris proposal tool documentation** uses the mkdocs material theme which in turn requires python to be installed. -You can find detailed theme instructions in the [mkdodcs material site](https://squidfunk.github.io/mkdocs-material/). +You can find detailed theme instructions in the [mkdodcs material site](https://squidfunk.github.io/mkdocs-material/). However, all of the necessary packages can be installed with ```shell -pip install mkdocs-material +pip install -r requirements.txt ``` ## plantuml -Various diagrams are created using plantuml - the markdown plugin for that can be installed with. +Various diagrams are created using [plantuml](https://plantuml.com). The way that this is integrated with markdown is like -```shell -pip install plantuml-markdown -``` + ```plantuml id="myDiag" format="png" classes="uml myDiagram" alt="My super diagram placeholder" title="My super diagram" width="300px" height="300px" + Goofy -> MickeyMouse: calls + Goofy <-- MickeyMouse: responds + ``` -## Running the website locally -Building and running the site locally requires python with the `mkdocs-material` package installed. -You can find out more about how to install mkdocs material for your environment in the -[Getting started](https://squidfunk.github.io/mkdocs-material/getting-started/) guide. +## Running the website locally Once you've made your working copy of the site repo, from the repo root folder, run: