blob: ebc4d3b223a72a12420965c460dca2041c16c321 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
|
[](https://travis-ci.org/Opendigitalradio/mmbtools-doc)
Documentation for ODR-mmbTools
==============================
This repository contains a LaTeX document that summarises the ODR-mmbTools.
The goal is to create something like a manual for the whole tool-set, which
complements the man-pages and documentation for each part with a more
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
--------------
It is a work in progress. No version has been released yet, but the
document gets compiled automatically by Travis-CI and uploaded to
http://opendigitalradio.github.io/mmbtools-doc/mmbtools.pdf
Acknowledgements
----------------
* Rash and Adam for proof-reading and corrections
* Wim Nelis for the section about Monitoring using Xymon
|
