firesim/docs
abejgonzalez cadd64bf5a Simple counter example (clock + reset + max-cycle timeout) 2024-09-23 12:23:32 -07:00
..
AWS-EC2-F1-Initial-Setup Remove Chipyard submod + Various bugfixes 2024-08-27 01:12:32 -07:00
Advanced-Usage Simple counter example (clock + reset + max-cycle timeout) 2024-09-23 12:23:32 -07:00
Developer-Docs Remove Chipyard submod + Various bugfixes 2024-08-27 01:12:32 -07:00
Getting-Started-Guides Remove Chipyard submod + Various bugfixes 2024-08-27 01:12:32 -07:00
Golden-Gate Remove Chipyard submod + Various bugfixes 2024-08-27 01:12:32 -07: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 documentation 2022-06-18 08:13:22 +00:00
tools pdfs to images script 2018-05-19 19:09:37 +00:00
.gitignore Port to Python3 + Switch to GH-A CI (#878) 2022-01-20 11:03:37 -08:00
External-Tutorial-Setup.rst Remove Chipyard submod + Various bugfixes 2024-08-27 01:12:32 -07:00
FireSim-Basics.rst Remove Chipyard submod + Various bugfixes 2024-08-27 01:12:32 -07:00
Local-FPGA-Initial-Setup.rst Remove Chipyard submod + Various bugfixes 2024-08-27 01:12:32 -07:00
Makefile Remove Chipyard submod + Various bugfixes 2024-08-27 01:12:32 -07:00
README.md bump docs requirements.txt to latest 2022-04-04 21:31:30 +00:00
Terminology.rst Remove Chipyard submod + Various bugfixes 2024-08-27 01:12:32 -07:00
conf.py Simple counter example (clock + reset + max-cycle timeout) 2024-09-23 12:23:32 -07:00
index.rst Remove Chipyard submod + Various bugfixes 2024-08-27 01:12:32 -07:00
make.bat New squashed FireSim repo for open-sourcing 2018-05-13 19:40:34 +00:00

README.md

Building Docs

sudo -E $CONDA_EXE install --file ./requirements.txt
make html

Look in the _build/html directory for output. You can also run

python3 -m http.server

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 /bin/bash -l -c ./install-tl

Follow the prompts, add the suggested path to your .bashrc.