replica
/
firesim
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
firesim/docs/index.rst

52 lines
1.2 KiB
ReStructuredText
Raw Normal View History

New squashed FireSim repo for open-sourcing This is the new FireSim repo that will be open-sourced. This commit matches the state of the repo at commit 031132485840608f111e6c745d8140b5def6d857 of the original FireSim repo, which now lives at https://github.com/firesim/firesim-prerelease All future FireSim development will happen in this repository. The FireSim pre-release repo is maintained privately only for archival purposes (e.g. if someone needs to do git blame on a file) - no new commits should be made on the pre-release repo.
2018-05-14 03:40:34 +08:00
.. FireSim documentation master file, created by
sphinx-quickstart on Thu Apr 26 23:51:51 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to FireSim's documentation!
===================================
guide users to the right place off the landing page
2018-05-19 07:34:20 +08:00
New to FireSim? Jump to the :ref:`firesim-basics` page for more info.
New squashed FireSim repo for open-sourcing This is the new FireSim repo that will be open-sourced. This commit matches the state of the repo at commit 031132485840608f111e6c745d8140b5def6d857 of the original FireSim repo, which now lives at https://github.com/firesim/firesim-prerelease All future FireSim development will happen in this repository. The FireSim pre-release repo is maintained privately only for archival purposes (e.g. if someone needs to do git blame on a file) - no new commits should be made on the pre-release repo.
2018-05-14 03:40:34 +08:00
.. toctree::
:maxdepth: 3
more documentation
2018-05-17 04:10:31 +08:00
:caption: Getting Started:
:numbered:
New squashed FireSim repo for open-sourcing This is the new FireSim repo that will be open-sourced. This commit matches the state of the repo at commit 031132485840608f111e6c745d8140b5def6d857 of the original FireSim repo, which now lives at https://github.com/firesim/firesim-prerelease All future FireSim development will happen in this repository. The FireSim pre-release repo is maintained privately only for archival purposes (e.g. if someone needs to do git blame on a file) - no new commits should be made on the pre-release repo.
2018-05-14 03:40:34 +08:00
FireSim-Basics
reorganize sections into directories
2018-05-15 06:59:48 +08:00
Initial-Setup/index
more restructuring
2018-05-19 09:14:28 +08:00
Running-Simulations-Tutorial/index
move Building section
2018-05-19 15:01:53 +08:00
Building-a-FireSim-AFI
more documentation
2018-05-17 04:10:31 +08:00
.. toctree::
:maxdepth: 3
:caption: Advanced Docs:
some restructuring
2018-05-19 15:09:24 +08:00
Advanced-Usage/Manager/index
more restructuring
2018-05-19 15:14:29 +08:00
Advanced-Usage/Workloads/index
[Docs] Describe how to generate different targets; BOOM
2018-07-10 09:34:06 +08:00
Advanced-Usage/Generating-Different-Targets.rst
restructure the debugging section
2020-02-09 06:24:08 +08:00
Advanced-Usage/Debugging-in-Software/index
Advanced-Usage/Debugging-and-Profiling-on-FPGA/index
more cleanup
2018-05-19 15:26:59 +08:00
Advanced-Usage/Supernode.rst
some restructuring
2018-05-19 15:09:24 +08:00
Advanced-Usage/Miscellaneous-Tips.rst
Added FAQ section
2018-09-29 11:58:23 +08:00
Advanced-Usage/FAQs.rst
more documentation
2018-05-17 04:10:31 +08:00
[docs] Add MIDAS overview & philosophy
2018-10-18 15:27:17 +08:00
.. toctree::
:maxdepth: 3
Use new file emission trait + makefile naming cleanup
2021-07-03 07:13:38 +08:00
:caption: Compiler (Golden Gate) Docs:
[docs] Add MIDAS overview & philosophy
2018-10-18 15:27:17 +08:00
More brain dump
2019-09-27 03:48:34 +08:00
Golden-Gate/Overview
Golden-Gate/LI-BDN
wip
2019-10-05 06:36:22 +08:00
Golden-Gate/Bridges
[docs] Add a UARTBridge Walkthrough
2020-01-23 02:53:58 +08:00
Golden-Gate/Bridge-Walkthrough
[docs] First-pass Trigger system documentation
2020-03-28 12:10:52 +08:00
Golden-Gate/Triggers
[docs] Add section on Golden Gate resource optimizations
2020-10-01 02:48:27 +08:00
Golden-Gate/Resource-Optimizations
Use new file emission trait + makefile naming cleanup
2021-07-03 07:13:38 +08:00
Golden-Gate/Output-Files
[docs] Add MIDAS overview & philosophy
2018-10-18 15:27:17 +08:00
New squashed FireSim repo for open-sourcing This is the new FireSim repo that will be open-sourced. This commit matches the state of the repo at commit 031132485840608f111e6c745d8140b5def6d857 of the original FireSim repo, which now lives at https://github.com/firesim/firesim-prerelease All future FireSim development will happen in this repository. The FireSim pre-release repo is maintained privately only for archival purposes (e.g. if someone needs to do git blame on a file) - no new commits should be made on the pre-release repo.
2018-05-14 03:40:34 +08:00
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`