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

docs: Clarify install instructions 

`config-clang` is the default, and doesn't need to be run first.  Previous instructions were ambiguous about that point.
Add note on using a different `CXX`.
This commit is contained in:
Krystine Sherwin 2024-03-18 10:35:01 +13:00
parent bc9cccacf2
commit 2832034877
No known key found for this signature in database
1 changed files with 17 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/source/getting_started/installation.rst
View File

@ -110,26 +110,33 @@ Installing all prerequisites for macOS 11 (with Homebrew):
Running the build system
^^^^^^^^^^^^^^^^^^^^^^^^
To configure the build system to use a specific compiler, use one of the
following:
.. code:: console
make config-clang
make config-gcc
Then, simply run ``make`` in this directory.
From the root `yosys` directory, call the following commands:
.. code:: console
make
sudo make install
Note that this also downloads, builds, and installs `ABC`_ (using
This will build and then install Yosys, making it available on the command line
as `yosys`. Note that this also downloads, builds, and installs `ABC`_ (using
:program:`yosys-abc` as the executable name).
.. _ABC: https://github.com/berkeley-abc/abc
The default compiler is ``clang``, to change between ``clang`` and ``gcc``, use
one of the following:
.. code:: console
make config-clang
make config-gcc
To use a compiler different than the default, use:
.. code:: console
make CXX="g++-11"
.. seealso::
Refer to :doc:`/test_suites` for details on testing Yosys once compiled.