Skip to content

projectara/greybus-spec

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

This is the Greybus Specification.

Requirements:

- Sphinx: http://sphinx-doc.org/contents.html
- LaTeX (and pdflatex, and various LaTeX packages)
- Graphviz (in particular, "dot"): http://www.graphviz.org/
- Mscgen: http://www.mcternan.me.uk/mscgen/
- Imagemagick: https://imagemagick.org

On Ubuntu:

# apt-get install python-sphinx texlive texlive-latex-extra texlive-humanities graphviz mscgen imagemagick librsvg2-bin

Then:

$ make latexpdf # For generating pdf
$ make html # For generating a hierarchy of html pages
$ make singlehtml # For generating a single html page

*************************************************************
*   MAKE SURE "make html" BUILDS WITHOUT WARNINGS BEFORE    *
*   SUBMITTING ANY PATCHES TO THE SPECIFICATION!            *
*************************************************************