diff --git a/README.md b/README.md index dad30d45d7a5b009fa04ea83b894beba62dd9da9..ea9bca616dd434fb0f4ef5a56835830beef130c0 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,18 @@ This is the companion paper to the [adaptive](https://adaptive.readthedocs.io/en/latest/) Python library. See the latest draft [here](https://gitlab.kwant-project.org/qt/adaptive-paper/builds/artifacts/master/file/paper.pdf?job=make). + +### Building the paper + +The simplest way to build the paper is with Docker, to make sure that all the necessary dependencies are installed. +First build the Docker image: + +``` +docker build -t adaptive-paper . +``` + +Then run `make` inside a docker container using the image you just built: + +``` +docker run -it --rm -v $(pwd):/work -w /work adaptive-paper make +```