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.

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

Changes to: Using Spinal from VSCodium #215

Merged
merged 8 commits into from
Oct 7, 2023
Merged
15 changes: 7 additions & 8 deletions source/SpinalHDL/Getting Started/VSCodium.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,13 @@ Using Spinal from VSCodium
==========================

.. note::
VSCode works the same way as VSCodium.
`VSCodium <https://vscodium.com/>`_ is the open source Microsoft Visual Studio application, but without the telemetry included in Microsoft's downloadable version.
PythonLinks marked this conversation as resolved.
Show resolved Hide resolved

As a one-time setup task, in the extensions options, install "Scala (Metals)".
As a one-time setup task, go to view->extensions search for "Scala" and install the "Scala (Metals)" extemsion. `WebPage <https://marketplace.visualstudio.com/items?itemName=scalameta.metals>`_
PythonLinks marked this conversation as resolved.
Show resolved Hide resolved

Open the workspace: ``File`` > ``Open Folder...`` and open the folder you have
downloaded earlier in :ref:`template`.
Open the workspace: ``File`` > ``Open Folder...`` and open the folder you have downloaded earlier in :ref:`template`.

The other way to start it, is to cd into the spinaltemplatesbt directory and type ``codium .``
andreasWallner marked this conversation as resolved.
Show resolved Hide resolved

Wait a little bit, a notification pop-up should appear on the bottom-right
corner: "Multiple build definitions found. Which would you like to use?". Click
Expand All @@ -18,11 +19,9 @@ corner: "Multiple build definitions found. Which would you like to use?". Click
Wait while running ``sbt bloopInstall``. Then a warning pop-up appears, you can
ignore it (don't show again).

In the explorer, find and open ``MyTopLevel.scala``. Wait a little bit, and see
the ``run | debug`` line that is displayed by Metals, before each ``App``. For
instance, click on ``run`` just above ``object MyTopLevelVerilog``. It performs
In the search bar, find and open ``MyTopLevel.scala``. Once it loads select Menu Bar -> Run -> Run Without Debugging. It performs
andreasWallner marked this conversation as resolved.
Show resolved Hide resolved
design checks and, as the checks pass, it generates the Verilog file
``MyTopLevel.v`` at the root of the workspace.
``MyTopLevel.v`` at the root of the workspace, in ./hw/gen/MyTopLevel.v
PythonLinks marked this conversation as resolved.
Show resolved Hide resolved

This is all you need to do to use Spinal from VSCodium!

Expand Down