3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2026-04-30 15:43:46 +00:00

Docs: Bringing prereqs in line

Add comments in setup-build-env/action.yml for where to document prereqs (and the separation between build/run and test).
Add some initial (very basic) text for `test_suites.rst`, listing prereqs and how to run the tests (with subsections for the different optional tests, which is currently docs, functional and unit).
Add sphinx-inline-tabs, use it for tidying up prereq instructions based on OS/platform (mostly helpful in the test suites doc where there are multiple sections split by OS).
Also fixes some single backticks that should be double backtick.
This commit is contained in:
Krystine Sherwin 2025-11-01 16:19:38 +13:00 committed by Miodrag Milanovic
parent a4bd40e199
commit cc5642c904
6 changed files with 117 additions and 39 deletions

View file

@ -83,9 +83,11 @@ Xdot (graphviz) is used by the ``show`` command in yosys to display schematics.
For example on Ubuntu Linux 22.04 LTS the following commands will install all
prerequisites for building yosys:
$ sudo apt-get install build-essential clang lld bison flex libfl-dev \
libreadline-dev gawk tcl-dev libffi-dev git \
graphviz xdot pkg-config python3-dev zlib1g-dev
$ sudo apt-get install gawk git make python3 lld \
bison clang flex libboost-filesystem-dev libboost-python-dev \
libboost-system-dev libbz2-dev libffi-dev libfl-dev \
libreadline-dev pkg-config tcl-dev zlib1g-dev \
graphviz xdot
$ curl -LsSf https://astral.sh/uv/install.sh | sh
The environment variable `CXX` can be used to control the C++ compiler used, or