firesim/docs
David Biancolin f1d8f5fc5a [heartbeat] update docs 2020-11-25 10:38:04 -08:00
..
Advanced-Usage [heartbeat] update docs 2020-11-25 10:38:04 -08:00
Golden-Gate [docs] Add section on Golden Gate resource optimizations 2020-09-30 11:48:27 -07:00
Initial-Setup [docs] machine-launchstatus does not include output 2020-05-31 21:04:32 +00:00
Running-Simulations-Tutorial Add init-submodules.sh step to simulation steps 2020-11-24 19:03:13 -08:00
_static add a logo 2020-02-10 04:14:50 +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 Cleanup docs 2020-02-25 11:49:56 -08: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 logo only 2020-02-10 04:18:47 +00:00
index.rst [docs] Add section on Golden Gate resource optimizations 2020-09-30 11:48:27 -07:00
make.bat New squashed FireSim repo for open-sourcing 2018-05-13 19:40:34 +00:00
requirements.txt [docs] Explain multiclock use and restrictions (#528) 2020-04-02 11:06:45 -07: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.