Gitiles
Code Review Sign In
gerrit.named-data.net / NDN-TLV / 777ae618c055b103dec26025b4eb287f5137604a
commit777ae618c055b103dec26025b4eb287f5137604a[log] [tgz]
authorDavide Pesavento <davidepesa@gmail.com>Sat Jan 14 21:09:00 2023 -0500
committerDavide Pesavento <davidepesa@gmail.com>Sun Jan 22 18:00:11 2023 -0500
tree5d1b959016407a80de447df13f7ef6e1c40a728c
parent6b2bb6294f47edb709b5fe7fe66cf44734b65292 [diff]
Update build dependencies, improve README

Change-Id: I9b0b7b0cc6f5991075ce144564ce567916b6fe6f
3 files changed
tree: 5d1b959016407a80de447df13f7ef6e1c40a728c
  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.