Merge pull request #6 from kth-step/doc-documentation

basic document building instructions
kth-step · Jan 23, 2024 · 7e9c87a · 7e9c87a
2 parents 56fb4c4 + 4e3edae
commit 7e9c87a
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git 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 <number-of-cores-on-your-machine> 
 ```
 
+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
@@ -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 <number-of-cores-on-your-machine> 
   ```
 
+  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