Docs: Note on releases

This commit is contained in:
Krystine Sherwin 2024-12-05 09:21:13 +13:00
parent a7ea375cfc
commit b9d73d0a8e
No known key found for this signature in database
1 changed files with 6 additions and 2 deletions

View File

@ -62,8 +62,6 @@ The `OSS CAD Suite`_ releases `nightly builds`_ for the following architectures:
Building from source Building from source
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
.. TODO:: discuss release packages (and figure out what is/isn't included)
The Yosys source files can be obtained from the `YosysHQ/Yosys git repository`_. The Yosys source files can be obtained from the `YosysHQ/Yosys git repository`_.
`ABC`_ and some of the other libraries used are included as git submodules. To `ABC`_ and some of the other libraries used are included as git submodules. To
clone these submodules at the same time, use e.g.: clone these submodules at the same time, use e.g.:
@ -78,6 +76,12 @@ clone these submodules at the same time, use e.g.:
.. _YosysHQ/Yosys git repository: https://github.com/yosyshq/yosys/ .. _YosysHQ/Yosys git repository: https://github.com/yosyshq/yosys/
.. _ABC: https://github.com/berkeley-abc/abc .. _ABC: https://github.com/berkeley-abc/abc
.. note::
As of Yosys v0.47, releases include a ``yosys.tar.gz`` file which includes
all source code and all sub-modules in a single archive. This can be used as
an alternative which does not rely on ``git``.
Supported platforms Supported platforms
^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^