firesim/docs
Sagar Karandikar 58e5d6934a
Merge pull request #108 from firesim/dev
FireSim 1.3.2 Release
2018-09-22 15:19:12 -07:00
..
Advanced-Usage Merge pull request #108 from firesim/dev 2018-09-22 15:19:12 -07:00
Developing-New-Devices switch to https submodules 2018-05-21 04:09:11 +00:00
Initial-Setup wip moving to 1.3.8 shell 2018-07-21 19:10:36 +00:00
Running-Simulations-Tutorial add notes to tutorials about simulating BOOM 2018-08-18 18:21:30 -07: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 update conf to show + signs next to expandable sections in docs 2018-05-19 17:58:46 +00:00
index.rst more docs updates 2018-09-20 17:11:52 +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.