firesim/docs
Sagar Karandikar 1984e2600a pdfs to images script 2018-05-19 19:09:37 +00:00
..
Advanced-Usage improve config file docs 2018-05-19 18:12:54 +00:00
Developing-New-Devices reorganize sections into directories 2018-05-14 15:59:48 -07:00
Initial-Setup more setup 2018-05-18 23:55:51 +00:00
Running-Simulations-Tutorial fix index 2018-05-19 06:56:07 +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 guide users to the right place off the landing page 2018-05-18 23:34:20 +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 update conf to show + signs next to expandable sections in docs 2018-05-19 17:58:46 +00:00
index.rst more cleanup 2018-05-19 07:26:59 +00: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.