diff --git a/README.md b/README.md index 66126bc1e..55eae1149 100644 --- a/README.md +++ b/README.md @@ -29,18 +29,20 @@ If you don't have time to lend a hand in that way but still want to have an impa You need to have [docker](https://docs.docker.com/engine/install/) and [docker-compose](https://docs.docker.com/compose/install/) installed in your environment. -If you edit the docs in vscode when you open the top level directory it will ask if you wish to `Reopen in Container` click that button and vscode will automatically run `docker compose up` which will then start serving the documentation as below, otherwise you can do it manually as below. +If you edit the docs in vscode when you open the top level directory it will ask if you wish to `Reopen in Container` click that button and vscode will automatically run `docker-compose up` which will then start serving the documentation as below, otherwise you can do it manually as below. + +If you run the container on debian, please install `docker.io`, `docker-compose` and `apparmor` as dependencies from system repos. Then you need to build your container: ``` -docker compose build +docker-compose build ``` and start mkdocs server: ``` -docker compose up +docker-compose up ``` After server is running visit [http://localhost:8000/](http://localhost:8000/).