firesim/docs
Nathan Pemberton 1f767e4df2
Merge pull request #465 from firesim/cleanMarshalDocs
Move even more documentation to FireMarshal's own readthedocs.
2020-01-24 16:03:02 -08:00
..
Advanced-Usage Merge pull request #465 from firesim/cleanMarshalDocs 2020-01-24 16:03:02 -08:00
Golden-Gate [docs] Add a UARTBridge Walkthrough 2020-01-22 12:48:05 -08:00
Initial-Setup Merge pull request #451 from firesim/master 2020-01-14 16:43:27 -08:00
Running-Simulations-Tutorial Move even more documentation to FireMarshal's own readthedocs. This also 2020-01-22 21:05:43 -05:00
_static New squashed FireSim repo for open-sourcing 2018-05-13 19:40:34 +00:00
img more documentation 2018-05-17 19:25:01 +00:00
tools pdfs to images script 2018-05-19 19:09:37 +00:00
.gitignore New squashed FireSim repo for open-sourcing 2018-05-13 19:40:34 +00:00
Building-a-FireSim-AFI.rst [docs] Change c5.4xlarge -> z1d.2xlarge; note Vivado memory usage 2020-01-22 22:44:49 +00:00
FireSim-Basics.rst [docs] Add Golden Gate to the terminology in FireSim Basics 2019-10-11 10:16:30 -04:00
Makefile more documentation 2018-05-17 19:25:01 +00:00
README.md update building docs README 2018-05-19 07:29:44 +00:00
conf.py Restore docs for old-style workload configuration. Move FireMarshal to 2019-02-21 14:48:01 -05:00
index.rst Move even more documentation to FireMarshal's own readthedocs. This also 2020-01-22 21:05:43 -05:00
make.bat New squashed FireSim repo for open-sourcing 2018-05-13 19:40:34 +00:00
requirements.txt update requirements.txt to match readthedocs versions 2018-05-19 17:55:04 +00:00

README.md

Building Docs

sudo pip install -r requirements.txt
make html

Look in the _build/html directory for output. You can also run

python -m SimpleHTTPServer

To get a proper locally-hosted version.

If you want to generate a pdf version, you will additionally need:

wget http://mirror.ctan.org/systems/texlive/tlnet/install-tl-unx.tar.gz
tar -xvf install-tl-unx.tar.gz
cd install-tl*
sudo ./install-tl

Follow the prompts, add the suggested path to your .bashrc.