firesim/docs
Abraham Gonzalez 8a67fc07d3
Rsync workload outputs (#877)
* Use rsync to copy back workload results

* Point to correct .ini file in runtime.ini

* Download files with rsync (not upload) | Update docs
2021-11-18 11:07:48 -08:00
..
Advanced-Usage Rsync workload outputs (#877) 2021-11-18 11:07:48 -08:00
Golden-Gate [docs] Output verilog is .sv not .v 2021-10-06 17:27:41 -07:00
Initial-Setup Vivado 2021.1 / AMI 1.11 (#837) 2021-10-06 12:12:48 -05: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
graffle-src/metasim-module-hierarchy.graffle Update MIDAS-level -> metasimulation naming in docs (#822) 2021-08-23 17:30:56 -04:00
img Update MIDAS-level -> metasimulation naming in docs (#822) 2021-08-23 17:30:56 -04: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 Use new file emission trait + makefile naming cleanup 2021-07-29 22:40:49 +00:00
make.bat New squashed FireSim repo for open-sourcing 2018-05-13 19:40:34 +00:00
requirements.txt Bump pygments from 2.2.0 to 2.7.4 in /docs (#770) 2021-06-03 17:13:54 -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.