Skip to content

Commit

Permalink
Merge pull request #227 from Readon/master
Browse files Browse the repository at this point in the history
add explaination on all-in-one offline installer.
  • Loading branch information
Readon authored Nov 10, 2023
2 parents d8212d6 + 43ece32 commit e5a893d
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion source/SpinalHDL/Getting Started/Install and setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,15 @@ when asked agree to an update of your ``PATH`` variable. Reboot to force an upda
This is sufficient for generating hardware. For simulation continue with either choice below.
In case you want to build the tools yourself have a look at the legacy simulation tool :ref:`installation instructions <sim backend install>`.

.. note::
An All-in-One solution offered by SpinalHDL maintainer `Readon <https://github.com/Readon>` is available to install and run SpinalHDL with Verilator simulation and formal verification via SymbiYosys.
Download `it <https://github.com/Readon/msys2-installer/releases>`_ and install the environment anywhere on your disk.
Start the build environment by clicking on the MSYS2-MINGW64 icon in the Start menu and use the MSYS2 default console.
An alternative is to use the Windows Terminal or a Tabby-like application and use the startup command ``%MSYS2_ROOT%\msys2_shell.cmd -defterm -here -no-start -mingw64``, where the ``%MSYS2_ROOT%`` is the location of the msys2 installation.
It is worth noting that if you want to use it offline, you should carefully select the libraries that the project depends on, otherwise you will need to download the packages manually.
See the README for the repos for more details.


MSYS2 verilator for simulation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down Expand Up @@ -186,7 +195,7 @@ With this you should be able to run sbt/verilator simulations from MSYS2 termina
MSYS2 for formal verification
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

In addition to the steps above we also need to install yosys, sby, z3 and yices. Both yosys and sby are
In addition to the steps above we also need to install yosys, sby, z3 and yices. Both yosys(yosys-smtbmc workable) and sby are
not available as official MSYS2 packages, but packages are provided by `Readon <https://github.com/Readon>`.
If you used their installer then these steps are not needed (you should check if there are newer packages available).

Expand Down

0 comments on commit e5a893d

Please sign in to comment.