Gitiles
Code Review Sign In
gerrit.named-data.net / NDN-TLV / bf06581a56fa5a0616fa55445a916bdcae28ff54
commitbf06581a56fa5a0616fa55445a916bdcae28ff54[log] [tgz]
authorDavide Pesavento <davidepesa@gmail.com>Wed Jul 26 17:45:36 2023 -0400
committerDavide Pesavento <davidepesa@gmail.com>Wed Jul 26 17:45:36 2023 -0400
treeb6fd7cfce201d868c8e1c157aa06a2ac8da8e006
parent933b86dc968805bc65a8d02f1e2f600086cc8081 [diff]
Update furo

Change-Id: Ic726eda63916011ac40d9401ce477c06783027c8
2 files changed
tree: b6fd7cfce201d868c8e1c157aa06a2ac8da8e006
  1. .github/
  2. _static/
  3. .gitignore
  4. certificate.rst
  5. changelog.rst
  6. conf.py
  7. data.rst
  8. index.rst
  9. interest.rst
  10. intro.rst
  11. link.rst
  12. Makefile
  13. name.rst
  14. README.md
  15. requirements.txt
  16. signature.rst
  17. signed-interest.rst
  18. tlv.rst
  19. types.rst
README.md

NDN Packet Format Specification

This repository contains the base packet format specification of the Named Data Networking (NDN) protocol.

An HTML version of the specification can be viewed online at https://docs.named-data.net/NDN-packet-spec/.

Compiling from source

Prerequisites

To "compile" the specification in HTML format, you must first install the Sphinx documentation generator and a few other dependencies. To do so, first make sure that the following packages are installed and up to date:

  • make
  • python 3.8 or later
  • pip

For instance, on Ubuntu Linux you can use the following commands:

sudo apt install make python3-pip
python3 -m pip install -U pip

On other operating systems, you can either use your preferred package manager or follow pip's installation instructions.

Finally, run:

python3 -m pip install -r requirements.txt

to install the recommended version of Sphinx and its dependencies.

Compilation

Just type:

make html

And a set of HTML pages will be generated inside _build/html.

You can also type:

make latexpdf

Sphinx will generate a .tex file and will try to compile it into a PDF document using latexmk and pdflatex (which must be installed). If successful, the final .pdf file can be found in _build/latex.

For further options, type make help.