firesim/docs
David Biancolin 08c966c2e4 Merge remote-tracking branch 'origin/master' into dev 2019-06-20 20:35:27 +00:00
..
Advanced-Usage Merge remote-tracking branch 'origin/master' into dev 2019-06-20 20:35:27 +00:00
Developing-New-Devices add FixedInputStream module to documentation 2018-11-07 11:18:15 -08:00
Initial-Setup Revert FireSim AMI related commits 2019-06-19 20:25:31 +00:00
Running-Simulations-Tutorial Merge remote-tracking branch 'origin/master' into dev 2019-06-20 20:35:27 +00: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 more build updates 2018-05-19 07:02:55 +00:00
FireSim-Basics.rst new pass over FireSim Basics 2018-05-20 23:57:02 +00: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 Restore docs for old-style workload configuration. Move FireMarshal to 2019-02-21 14:48:01 -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.