From 753057733f43a6d6f36e8714df565d4b9a1c5270 Mon Sep 17 00:00:00 2001 From: PythonLinks <34622952+PythonLinks@users.noreply.github.com> Date: Fri, 6 Oct 2023 10:01:02 +0200 Subject: [PATCH 1/7] Update VSCodium.rst Minor edits to make things clearer. Added some links. --- source/SpinalHDL/Getting Started/VSCodium.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/source/SpinalHDL/Getting Started/VSCodium.rst b/source/SpinalHDL/Getting Started/VSCodium.rst index b4755521321..83b87edcdff 100644 --- a/source/SpinalHDL/Getting Started/VSCodium.rst +++ b/source/SpinalHDL/Getting Started/VSCodium.rst @@ -4,12 +4,13 @@ Using Spinal from VSCodium ========================== .. note:: - VSCode works the same way as VSCodium. + `VSCodium `_ is the open source Microsoft Visual Studio application, 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)" extemsion. `WebPage `_ -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 .`` 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 @@ -18,7 +19,7 @@ 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 +In the search bar, 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 From d9217d468d6fce1e1fa5f756ed39e16e9fc15f25 Mon Sep 17 00:00:00 2001 From: PythonLinks <34622952+PythonLinks@users.noreply.github.com> Date: Fri, 6 Oct 2023 11:41:22 +0200 Subject: [PATCH 2/7] Update VSCodium.rst I deleted the instructions which did not work for me on Mac oS X. Maybe they were for an older version of the Scala (Metal) extensions. Added some links and text and generally cleared up the page. --- source/SpinalHDL/Getting Started/VSCodium.rst | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/source/SpinalHDL/Getting Started/VSCodium.rst b/source/SpinalHDL/Getting Started/VSCodium.rst index 83b87edcdff..6ba73288e6a 100644 --- a/source/SpinalHDL/Getting Started/VSCodium.rst +++ b/source/SpinalHDL/Getting Started/VSCodium.rst @@ -19,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 search bar, 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 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 This is all you need to do to use Spinal from VSCodium! From 4bfd5494d5c6be0a87c18a40008c34cadf28617c Mon Sep 17 00:00:00 2001 From: PythonLinks <34622952+PythonLinks@users.noreply.github.com> Date: Fri, 6 Oct 2023 19:09:41 +0200 Subject: [PATCH 3/7] Update source/SpinalHDL/Getting Started/VSCodium.rst Co-authored-by: Andreas Wallner --- source/SpinalHDL/Getting Started/VSCodium.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/SpinalHDL/Getting Started/VSCodium.rst b/source/SpinalHDL/Getting Started/VSCodium.rst index 6ba73288e6a..28887416585 100644 --- a/source/SpinalHDL/Getting Started/VSCodium.rst +++ b/source/SpinalHDL/Getting Started/VSCodium.rst @@ -6,7 +6,7 @@ Using Spinal from VSCodium .. note:: `VSCodium `_ is the open source Microsoft Visual Studio application, but without the telemetry included in Microsoft's downloadable version. -As a one-time setup task, go to view->extensions search for "Scala" and install the "Scala (Metals)" extemsion. `WebPage `_ +As a one-time setup task, go to view->extensions search for "Scala" and install the "Scala (Metals)" `extension `_ Open the workspace: ``File`` > ``Open Folder...`` and open the folder you have downloaded earlier in :ref:`template`. From 15ec0283bf889175bb00d58d304b0cafc5fa30ce Mon Sep 17 00:00:00 2001 From: PythonLinks <34622952+PythonLinks@users.noreply.github.com> Date: Fri, 6 Oct 2023 19:13:55 +0200 Subject: [PATCH 4/7] Update source/SpinalHDL/Getting Started/VSCodium.rst Co-authored-by: Andreas Wallner --- source/SpinalHDL/Getting Started/VSCodium.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/SpinalHDL/Getting Started/VSCodium.rst b/source/SpinalHDL/Getting Started/VSCodium.rst index 28887416585..57a6674d247 100644 --- a/source/SpinalHDL/Getting Started/VSCodium.rst +++ b/source/SpinalHDL/Getting Started/VSCodium.rst @@ -4,7 +4,7 @@ Using Spinal from VSCodium ========================== .. note:: - `VSCodium `_ is the open source Microsoft Visual Studio application, but without the telemetry included in Microsoft's downloadable version. + `VSCodium `_ 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, go to view->extensions search for "Scala" and install the "Scala (Metals)" `extension `_ From f5e61d87e2c751d5b12a02af5fc6fcb377e18666 Mon Sep 17 00:00:00 2001 From: PythonLinks <34622952+PythonLinks@users.noreply.github.com> Date: Fri, 6 Oct 2023 19:20:25 +0200 Subject: [PATCH 5/7] Update VSCodium.rst I agree with your comment that it may place people in the wrong directory. I prefer to access things this way, others may also. So I removed the name of the directory. --- source/SpinalHDL/Getting Started/VSCodium.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/SpinalHDL/Getting Started/VSCodium.rst b/source/SpinalHDL/Getting Started/VSCodium.rst index 57a6674d247..6e462e46799 100644 --- a/source/SpinalHDL/Getting Started/VSCodium.rst +++ b/source/SpinalHDL/Getting Started/VSCodium.rst @@ -10,7 +10,7 @@ As a one-time setup task, go to view->extensions search for "Scala" and install 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 .`` +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 From 49ee447663c08afc1c9d84fe77797dcdb16ba807 Mon Sep 17 00:00:00 2001 From: PythonLinks <34622952+PythonLinks@users.noreply.github.com> Date: Fri, 6 Oct 2023 19:25:44 +0200 Subject: [PATCH 6/7] Update source/SpinalHDL/Getting Started/VSCodium.rst Co-authored-by: Andreas Wallner --- source/SpinalHDL/Getting Started/VSCodium.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/SpinalHDL/Getting Started/VSCodium.rst b/source/SpinalHDL/Getting Started/VSCodium.rst index 6e462e46799..f78bbdc296d 100644 --- a/source/SpinalHDL/Getting Started/VSCodium.rst +++ b/source/SpinalHDL/Getting Started/VSCodium.rst @@ -21,7 +21,7 @@ ignore it (don't show again). In the search bar, find and open ``MyTopLevel.scala``. Once it loads select Menu Bar -> Run -> Run Without Debugging. It performs design checks and, as the checks pass, it generates the Verilog file -``MyTopLevel.v`` at the root of the workspace, in ./hw/gen/MyTopLevel.v +``MyTopLevel.v`` at the root of the workspace, in ``./hw/gen/MyTopLevel.v`` This is all you need to do to use Spinal from VSCodium! From ee2aee57b0c00a82cc2f502ff52651d6d1f62330 Mon Sep 17 00:00:00 2001 From: PythonLinks <34622952+PythonLinks@users.noreply.github.com> Date: Sat, 7 Oct 2023 07:28:32 +0200 Subject: [PATCH 7/7] Update VSCodium.rst So I dropped the search suggestion, and used your approach of giving them the path. That is also better, because the new user is learning the directory structure. And I reviewed the whole document again, added a period here, and a sentence or two there. Thank you for giving me the chance to learn how these tools work. Thank you for being so careful in how you do things, and in your blindingly fast response. It makes SpinalHDL look really really good. --- source/SpinalHDL/Getting Started/VSCodium.rst | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/source/SpinalHDL/Getting Started/VSCodium.rst b/source/SpinalHDL/Getting Started/VSCodium.rst index f78bbdc296d..9e951a9e5cd 100644 --- a/source/SpinalHDL/Getting Started/VSCodium.rst +++ b/source/SpinalHDL/Getting Started/VSCodium.rst @@ -6,7 +6,7 @@ Using Spinal from VSCodium .. note:: `VSCodium `_ 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, go to view->extensions search for "Scala" and install the "Scala (Metals)" `extension `_ +As a one-time setup task, go to view->extensions search for "Scala" and install the "Scala (Metals)" `extension `_. Open the workspace: ``File`` > ``Open Folder...`` and open the folder you have downloaded earlier in :ref:`template`. @@ -19,10 +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 search bar, find and open ``MyTopLevel.scala``. Once it loads select Menu Bar -> Run -> Run Without Debugging. It performs -design checks and, as the checks pass, it generates the Verilog file -``MyTopLevel.v`` at the root of the workspace, in ``./hw/gen/MyTopLevel.v`` +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`.