From ea566fb32ce793a7d57dd377b31a27ea5f6d4873 Mon Sep 17 00:00:00 2001 From: Joseph Weston <joseph@weston.cloud> Date: Thu, 3 Oct 2019 10:35:20 +0200 Subject: [PATCH] add instructions for building the paper --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index dad30d4..ea9bca6 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 +``` -- GitLab