Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add explaination on all-in-one offline installer. #227

Merged
merged 3 commits into from
Nov 10, 2023
Merged

add explaination on all-in-one offline installer. #227

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7a5fada
add explaination on all-in-one offline installer.
Readon Nov 9, 2023
3229f42
Update source/SpinalHDL/Getting Started/Install and setup.rst
Readon Nov 10, 2023
43ece32
Update Install and setup.rst for more details on yosys-smtbmc.
Readon Nov 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion source/SpinalHDL/Getting Started/Install and setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _Install:

Install and setup
=================

Check warning on line 4 in source/SpinalHDL/Getting Started/Install and setup.rst

View workflow job for this annotation

GitHub Actions / test 

Duplicate explicit target name: "it".

Check warning on line 4 in source/SpinalHDL/Getting Started/Install and setup.rst

View workflow job for this annotation

GitHub Actions / build 

Duplicate explicit target name: "it".

Spinal is a Scala library (a programming language using the Java VM) so it
requires setting up a Scala environment; there are many ways to do so.
Expand Down Expand Up @@ -145,6 +145,15 @@
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 @@
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