| Davide Pesavento | 04af5f2 | 2020-06-21 22:02:47 -0400 | [diff] [blame^] | 1 | # NDN Packet Format Specification |
| Alexander Afanasyev | 26f0ff8 | 2013-11-21 23:22:41 +0000 | [diff] [blame] | 2 | |
| Davide Pesavento | 04af5f2 | 2020-06-21 22:02:47 -0400 | [diff] [blame^] | 3 | ## Prerequisites |
| Alexander Afanasyev | 26f0ff8 | 2013-11-21 23:22:41 +0000 | [diff] [blame] | 4 | |
| Davide Pesavento | 04af5f2 | 2020-06-21 22:02:47 -0400 | [diff] [blame^] | 5 | To "compile" the specification in HTML format, you must first install the Sphinx documentation generator. |
| Alexander Afanasyev | 1f53de4 | 2013-12-01 19:25:55 +0000 | [diff] [blame] | 6 | |
| Davide Pesavento | 04af5f2 | 2020-06-21 22:02:47 -0400 | [diff] [blame^] | 7 | If you're running Ubuntu Linux: |
| Alexander Afanasyev | 26f0ff8 | 2013-11-21 23:22:41 +0000 | [diff] [blame] | 8 | |
| Davide Pesavento | 04af5f2 | 2020-06-21 22:02:47 -0400 | [diff] [blame^] | 9 | sudo apt install make python3-pip |
| 10 | pip3 install -U pip setuptools |
| 11 | pip3 install -U sphinx sphinxcontrib-bibtex sphinxcontrib-fulltoc |
| Alexander Afanasyev | 26f0ff8 | 2013-11-21 23:22:41 +0000 | [diff] [blame] | 12 | |
| Davide Pesavento | 04af5f2 | 2020-06-21 22:02:47 -0400 | [diff] [blame^] | 13 | If you're running macOS or another operating system, see the instructions at https://www.sphinx-doc.org/en/master/usage/installation.html |
| Alexander Afanasyev | 1f53de4 | 2013-12-01 19:25:55 +0000 | [diff] [blame] | 14 | |
| Davide Pesavento | 04af5f2 | 2020-06-21 22:02:47 -0400 | [diff] [blame^] | 15 | ## Compilation |
| Alexander Afanasyev | 26f0ff8 | 2013-11-21 23:22:41 +0000 | [diff] [blame] | 16 | |
| Davide Pesavento | 04af5f2 | 2020-06-21 22:02:47 -0400 | [diff] [blame^] | 17 | Just type: |
| Alexander Afanasyev | 26f0ff8 | 2013-11-21 23:22:41 +0000 | [diff] [blame] | 18 | |
| 19 | make html |
| 20 | |
| Davide Pesavento | 04af5f2 | 2020-06-21 22:02:47 -0400 | [diff] [blame^] | 21 | And a set of HTML pages will be generated under `_build/html`. |
| Alexander Afanasyev | 26f0ff8 | 2013-11-21 23:22:41 +0000 | [diff] [blame] | 22 | |
| Davide Pesavento | 04af5f2 | 2020-06-21 22:02:47 -0400 | [diff] [blame^] | 23 | You can also type: |
| Alexander Afanasyev | 26f0ff8 | 2013-11-21 23:22:41 +0000 | [diff] [blame] | 24 | |
| 25 | make latexpdf |
| 26 | |
| Davide Pesavento | 04af5f2 | 2020-06-21 22:02:47 -0400 | [diff] [blame^] | 27 | Sphinx will generate a `.tex` file and will try to create a `.pdf` document from it using `pdflatex` (which must be installed). |
| Alexander Afanasyev | 26f0ff8 | 2013-11-21 23:22:41 +0000 | [diff] [blame] | 28 | |
| Davide Pesavento | 04af5f2 | 2020-06-21 22:02:47 -0400 | [diff] [blame^] | 29 | For further options, type `make help`. |