From 4e3edae8450c6902d428836b84cf250bd01e8a9d Mon Sep 17 00:00:00 2001 From: Karl Palmskog Date: Tue, 23 Jan 2024 11:03:05 +0100 Subject: [PATCH] basic document building instructions --- README.md | 8 +++++++- meta.yml | 8 +++++++- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2fe3acd..7209b87 100644 --- a/README.md +++ b/README.md @@ -36,13 +36,19 @@ opam install coq.8.18.0 coq-ott ``` To build when dependencies are installed, do: - ```shell git clone https://github.com/kth-step/abs-metatheory.git cd abs-metatheory make # or make -j ``` +To build a pdf documenting the project, ensure that `ott` and +TeX Live (`pdflatex`) are installed, and do: +```shell +make docs/report/main.pdf +``` +Note that the source file to edit for this pdf is `docs/report/main.mng`. + ## Documentation - [latest technical report](https://kth-step.github.io/abs-metatheory/docs/report/main.pdf) diff --git a/meta.yml b/meta.yml index f3341f3..3214078 100644 --- a/meta.yml +++ b/meta.yml @@ -58,13 +58,19 @@ build: |- ``` To build when dependencies are installed, do: - ```shell git clone https://github.com/kth-step/abs-metatheory.git cd abs-metatheory make # or make -j ``` + To build a pdf documenting the project, ensure that `ott` and + TeX Live (`pdflatex`) are installed, and do: + ```shell + make docs/report/main.pdf + ``` + Note that the source file to edit for this pdf is `docs/report/main.mng`. + documentation: |- ## Documentation