riscv
/
yosys
mirror of https://github.com/YosysHQ/yosys.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
yosys/docs/source/getting_started/index.rst

12 lines
193 B
ReStructuredText
Raw Normal View History

Reorganising documentation Also changing to furo theme.
2023-08-02 16:20:29 -05:00
Getting started with Yosys
==========================
TODOs Blocking tasks are now capital TODO (compared to non-blocking todo). Updated some of the todos. Added note about which intel synth does which families. Rename extended Yosys universe to Yosys family. Added brief text to landing page, and also a note about the restructure and where to find old docs. Moved todolist above ToC in preparation for disabling it in the config (so that it doesn't need it's own header). Fixed pdf build, was previously breaking on trying to include the svg badges.
2023-12-11 17:05:45 -06:00
.. todo:: brief overview for the getting started index
Reorganising documentation Also changing to furo theme.
2023-08-02 16:20:29 -05:00
.. toctree::
WIP merging synth phases with example Replace `typical_phases.rst` and `examples.rst` with a single `example_synth.rst`. Also updating the counter example to match. Aims to reduce redundancy, and simplify the getting started section. Details on things like `proc`, `memory` and `fsm` should instead be in the advanced section (under the new `synth` subsection).
2023-12-06 18:04:46 -06:00
:maxdepth: 3
Reorganising documentation Also changing to furo theme.
2023-08-02 16:20:29 -05:00
WIP merging synth phases with example Replace `typical_phases.rst` and `examples.rst` with a single `example_synth.rst`. Also updating the counter example to match. Aims to reduce redundancy, and simplify the getting started section. Details on things like `proc`, `memory` and `fsm` should instead be in the advanced section (under the new `synth` subsection).
2023-12-06 18:04:46 -06:00
installation
scripting_intro
example_synth