README
1This folder includes source files (text and graphics) for Scapy's documentation,
2which is automatically built using Sphinx <http://sphinx.pocoo.org/>
3
4The *.rst files are written as reStructuredText and should be quite readable
5in your favourite text editor without any further formatting.
6
7To generate much nicer, searchable HTML docs, install Sphinx, open a command
8line, change to the directory where this README is placed, and type the
9following command:
10
11 $ make html
12
13To generate a single PDF file (useful for printing) you need a working
14LaTeX installation (e.g. <http://www.tug.org/texlive/>).
15The following commands produce the file Scapy.pdf (>100 pages):
16
17 $ make latex
18 $ cd _build/latex
19 $ make all-pdf