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
Changes from all commits
Commits
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
20 changes: 9 additions & 11 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 build of Visual Studio Code, but without the telemetry included in Microsoft's downloadable version.

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)" `extension <https://marketplace.visualstudio.com/items?itemName=scalameta.metals>`_.

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 appropriate directory and type ``codium .``

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,12 +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
design checks and, as the checks pass, it generates the Verilog file
``MyTopLevel.v`` at the root of the workspace.
Find and open ``hw/spinal/projectname/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``. Alternatively, you can select Menu Bar -> Run -> Run Without Debugging. Either approach performs design checks and, as the checks pass, generates the Verilog file
``./hw/gen/MyTopLevel.v``

This is all you need to do to use Spinal from VSCodium!
This is all you need to do to use SpinalHDL from VSCodium. You now have the design-rule-checked Verilog and/or VHDL which you can use as input to your favorite synthesis tool.

Now you can use your environment, let's explore the code: :ref:`Simple example`.
Now that you know how to use the VSCodium development environment, let's explore the code: :ref:`Simple example`.