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

14 lines
341 B
ReStructuredText
Raw Normal View History

Reorganising documentation Also changing to furo theme.
2023-08-02 23:20:29 +02:00
Getting started with Yosys
==========================
Docs: getting_started tidy Rename `show` intro and point to `/cmd/show`. Add getting_started section overview.
2024-01-21 23:35:00 +01:00
This section covers how to get started with Yosys, from installation to a guided
walkthrough of synthesizing a design for hardware, and finishing with an
introduction to writing re-usable Yosys scripts.
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-12 00:05:45 +01:00
Reorganising documentation Also changing to furo theme.
2023-08-02 23:20:29 +02: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-07 01:04:46 +01:00
:maxdepth: 3
Reorganising documentation Also changing to furo theme.
2023-08-02 23:20:29 +02: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-07 01:04:46 +01:00
installation
example_synth
Docs: reworking scripting_intro Now comes *after* example_synth, with references back to it. Includes some minor adjustment to the `fifo.ys` script to better demonstrate the `select` command. Still needs an updated section on `show`. Also includes some other minor updates.
2024-01-18 03:33:59 +01:00
scripting_intro