Skip to content

Commit 12b4b18

Browse files
committed
docs/install: link to playground.
1 parent 2ab3a4a commit 12b4b18

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

docs/install.rst

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,20 @@
11
Installation
22
############
33

4+
.. _install-playground:
5+
6+
In-browser playground
7+
=====================
8+
9+
You can try Amaranth out without installing anything by visiting the `Amaranth Playground`_. The playground webpage contains a `fully functional Python interpreter <Pyodide_>`_ and an Amaranth toolchain that can simulate a design, display waveforms, and generate Verilog code. It works on all modern browsers that support WebAssembly_, including Firefox, Chrome, and Edge.
10+
11+
.. _Amaranth Playground: https://amaranth-lang.org/play/
12+
.. _Pyodide: https://pyodide.org/en/stable/
13+
.. _WebAssembly: https://webassembly.org/
14+
15+
16+
.. _install-sysreqs:
17+
418
System requirements
519
===================
620

@@ -11,9 +25,9 @@ System requirements
1125

1226
Amaranth HDL requires Python 3.8; it works on CPython_ 3.8 (or newer), and works faster on PyPy3.8_ 7.3.7 (or newer). Installation requires pip_ 23.0 (or newer).
1327

14-
For most workflows, Amaranth requires Yosys_ |yosys-version|. A compatible version of Yosys is distributed via PyPI_ for most popular platforms.
28+
For most workflows, Amaranth requires Yosys_ |yosys-version|. A `compatible version of Yosys <amaranth-yosys_>`_ is distributed via PyPI_ for most popular platforms, so it is usually not necessary to install Yosys separately.
1529

16-
Simulating Amaranth code requires no additional software. However, a waveform viewer like GTKWave_ is invaluable for debugging.
30+
Simulating Amaranth code requires no additional software. However, a waveform viewer like GTKWave_ is invaluable for debugging. As an alternative to GTKWave, the `Amaranth Playground`_ can be used to display waveforms for simple designs.
1731

1832
Synthesizing, placing and routing an Amaranth design for an FPGA requires the FPGA family specific toolchain.
1933

@@ -23,6 +37,7 @@ Synthesizing, placing and routing an Amaranth design for an FPGA requires the FP
2337
.. _PyPy3.8: https://www.pypy.org/
2438
.. _pip: https://pip.pypa.io/en/stable/
2539
.. _Yosys: https://yosyshq.net/yosys/
40+
.. _amaranth-yosys: https://pypi.org/project/amaranth-yosys/
2641
.. _PyPI: https://pypi.org/
2742
.. _GTKWave: https://gtkwave.sourceforge.net/
2843

@@ -120,6 +135,7 @@ Installing prerequisites
120135
121136
$ pip3 install --user --upgrade pip
122137
138+
123139
.. _install:
124140

125141
Installing Amaranth

0 commit comments

Comments
 (0)