aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMatthias P. Braendli <matthias.braendli@mpb.li>2023-08-09 13:59:56 +0200
committerGitHub <noreply@github.com>2023-08-09 13:59:56 +0200
commitcb7e62bcf70a487f0d297dd09ec9abc351a6191d (patch)
tree0e65b9c88483f9b488809572e8bc71f69b98bdc8 /README.md
parent1224aa3206a460eb20b5f6cf3928d493660490f4 (diff)
parentc2290b277ba58969096d4af04b79974043dde629 (diff)
downloadmmbtools-doc-cb7e62bcf70a487f0d297dd09ec9abc351a6191d.tar.gz
mmbtools-doc-cb7e62bcf70a487f0d297dd09ec9abc351a6191d.tar.bz2
mmbtools-doc-cb7e62bcf70a487f0d297dd09ec9abc351a6191d.zip
Merge pull request #11 from colisee/master
Miscellaneous improvements
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 386dc5b..ebc4d3b 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,16 @@ global perspective.
It also complements the opendigitalradio.org wiki.
+How to build locally
+--------------------
+
+The pdf document will always be created automatically by the github repository upon a push.
+However, it can be interesting to create the pdf on your host, in order to check the outcome of your changes prior to pushing them to the repository.
+
+On your debian-based host:
+1. Install the packages: `make texlive texlive-fonts-extra texlive-latex-extra texlive-science cm-super`
+1. Run the following command: `make clean && make`
+
Latest Version
--------------