From d003ece14583976c8168e96a882de2cea4a8b7d8 Mon Sep 17 00:00:00 2001 From: Joshua Fife Date: Mon, 25 Oct 2021 08:02:46 -0600 Subject: [PATCH] fixed readmes and scripts to match #206 Signed-off-by: Joshua Fife --- .github/scripts/build-examples.sh | 55 +++++++++++++++---- projf-makefiles/hello/hello-arty/B/README.rst | 8 +-- projf-makefiles/hello/hello-arty/C/README.rst | 8 +-- projf-makefiles/hello/hello-arty/D/README.rst | 8 +-- projf-makefiles/hello/hello-arty/E/README.rst | 4 +- projf-makefiles/hello/hello-arty/F/README.rst | 4 +- projf-makefiles/hello/hello-arty/G/README.rst | 4 +- projf-makefiles/hello/hello-arty/H/README.rst | 4 +- projf-makefiles/hello/hello-arty/I/README.rst | 4 +- projf-makefiles/hello/hello-arty/J/README.rst | 4 +- projf-makefiles/hello/hello-arty/K/README.rst | 9 +-- projf-makefiles/hello/hello-arty/L/README.rst | 8 +-- 12 files changed, 77 insertions(+), 43 deletions(-) diff --git a/.github/scripts/build-examples.sh b/.github/scripts/build-examples.sh index d1616cc..57f0e27 100755 --- a/.github/scripts/build-examples.sh +++ b/.github/scripts/build-examples.sh @@ -91,37 +91,70 @@ if [ "$fpga_family" = "xc7" ]; then snippets="${activate_env} projf-makefiles/hello/hello-arty/A/README.rst:hello-arty-a" ;; "hello-b") - snippets="${activate_env} projf-makefiles/hello/hello-arty/B/README.rst:hello-arty-B" + snippets="${activate_env} projf-makefiles/hello/hello-arty/B/README.rst:hello-arty-b" ;; "hello-c") - snippets="${activate_env} projf-makefiles/hello/hello-arty/C/README.rst:hello-arty-C" + snippets="${activate_env} projf-makefiles/hello/hello-arty/C/README.rst:hello-arty-c" ;; "hello-d") - snippets="${activate_env} projf-makefiles/hello/hello-arty/D/README.rst:hello-arty-D" + snippets="${activate_env} projf-makefiles/hello/hello-arty/D/README.rst:hello-arty-d" ;; "hello-e") - snippets="${activate_env} projf-makefiles/hello/hello-arty/E/README.rst:hello-arty-E" + snippets="${activate_env} projf-makefiles/hello/hello-arty/E/README.rst:hello-arty-e" ;; "hello-f") - snippets="${activate_env} projf-makefiles/hello/hello-arty/F/README.rst:hello-arty-F" + snippets="${activate_env} projf-makefiles/hello/hello-arty/F/README.rst:hello-arty-f" ;; "hello-g") - snippets="${activate_env} projf-makefiles/hello/hello-arty/G/README.rst:hello-arty-G" + snippets="${activate_env} projf-makefiles/hello/hello-arty/G/README.rst:hello-arty-g" ;; "hello-h") - snippets="${activate_env} projf-makefiles/hello/hello-arty/H/README.rst:hello-arty-H" + snippets="${activate_env} projf-makefiles/hello/hello-arty/H/README.rst:hello-arty-h" ;; "hello-i") - snippets="${activate_env} projf-makefiles/hello/hello-arty/I/README.rst:hello-arty-I" + snippets="${activate_env} projf-makefiles/hello/hello-arty/I/README.rst:hello-arty-i" ;; "hello-j") - snippets="${activate_env} projf-makefiles/hello/hello-arty/J/README.rst:hello-arty-J" + snippets="${activate_env} projf-makefiles/hello/hello-arty/J/README.rst:hello-arty-j" ;; "hello-k") - snippets="${activate_env} projf-makefiles/hello/hello-arty/K/README.rst:hello-arty-K" + snippets="${activate_env} projf-makefiles/hello/hello-arty/K/README.rst:hello-arty-k" ;; "hello-l") - snippets="${activate_env} projf-makefiles/hello/hello-arty/L/README.rst:hello-arty-L" + snippets="${activate_env} projf-makefiles/hello/hello-arty/L/README.rst:hello-arty-l" + ;; + "hello-b") + snippets="${activate_env} projf-makefiles/hello/hello-arty/B/README.rst:hello-arty-b" + ;; + "hello-c") + snippets="${activate_env} projf-makefiles/hello/hello-arty/C/README.rst:hello-arty-c" + ;; + "hello-d") + snippets="${activate_env} projf-makefiles/hello/hello-arty/D/README.rst:hello-arty-d" + ;; + "hello-e") + snippets="${activate_env} projf-makefiles/hello/hello-arty/E/README.rst:hello-arty-e" + ;; + "hello-f") + snippets="${activate_env} projf-makefiles/hello/hello-arty/F/README.rst:hello-arty-f" + ;; + "hello-g") + snippets="${activate_env} projf-makefiles/hello/hello-arty/G/README.rst:hello-arty-g" + ;; + "hello-h") + snippets="${activate_env} projf-makefiles/hello/hello-arty/H/README.rst:hello-arty-h" + ;; + "hello-i") + snippets="${activate_env} projf-makefiles/hello/hello-arty/I/README.rst:hello-arty-i" + ;; + "hello-j") + snippets="${activate_env} projf-makefiles/hello/hello-arty/J/README.rst:hello-arty-j" + ;; + "hello-k") + snippets="${activate_env} projf-makefiles/hello/hello-arty/K/README.rst:hello-arty-k" + ;; + "hello-l") + snippets="${activate_env} projf-makefiles/hello/hello-arty/L/README.rst:hello-arty-l" ;; *) echo "ERROR: Unknown example name: $example" >&2 diff --git a/projf-makefiles/hello/hello-arty/B/README.rst b/projf-makefiles/hello/hello-arty/B/README.rst index 631b155..3a80252 100644 --- a/projf-makefiles/hello/hello-arty/B/README.rst +++ b/projf-makefiles/hello/hello-arty/B/README.rst @@ -4,13 +4,13 @@ Part 1 Design B This design allows you to turn four LEDs on and off with switches 0 and 1. Control LEDs 0 and 1 with switch 0 and LEDs 2 and 3 with switch 1. To build this design run the following in the root symbiflow-example directory: -.. code:: bash - :name: hello-arty-B +.. code-block:: bash + :name: hello-arty-b - TARGET="arty_35" make -C projf-makefiles/hello/hello-arty/B" + TARGET="arty_35" make -C projf-makefiles/hello/hello-arty/B You can then download the bitstream by running: .. code:: bash - TARGET="arty_35" make download -C projf-makefiles/hello/hello-arty/B" + TARGET="arty_35" make download -C projf-makefiles/hello/hello-arty/B diff --git a/projf-makefiles/hello/hello-arty/C/README.rst b/projf-makefiles/hello/hello-arty/C/README.rst index 104d1c1..71d6fa3 100644 --- a/projf-makefiles/hello/hello-arty/C/README.rst +++ b/projf-makefiles/hello/hello-arty/C/README.rst @@ -5,13 +5,13 @@ This design has the same functionality in hardware as part C but demonstrates the use of conditional operators in System Verilog. To build this design run the following command in the main symbiflow directory: -.. code:: bash - :name: hello-arty-C +.. code-block:: bash + :name: hello-arty-c - TARGET="arty_35" make -C projf-makefiles/hello/hello-arty/C" + TARGET="arty_35" make -C projf-makefiles/hello/hello-arty/C You can then download the bitstream by running: .. code:: bash - TARGET="arty_35" make download -C projf-makefiles/hello/hello-arty/C" + TARGET="arty_35" make download -C projf-makefiles/hello/hello-arty/C diff --git a/projf-makefiles/hello/hello-arty/D/README.rst b/projf-makefiles/hello/hello-arty/D/README.rst index 7014c1c..3b1ed69 100644 --- a/projf-makefiles/hello/hello-arty/D/README.rst +++ b/projf-makefiles/hello/hello-arty/D/README.rst @@ -4,13 +4,13 @@ Part 1 Design D This design is the fourth design from Part 1 of Hello Arty. To build this design run the following command in the main symbiflow directory: -.. code:: bash - :name: hello-arty-D +.. code-block:: bash + :name: hello-arty-d - TARGET="arty_35" make -C projf-makefiles/hello/hello-arty/D" + TARGET="arty_35" make -C projf-makefiles/hello/hello-arty/D You can then download the bitstream by running: .. code:: bash - TARGET="arty_35" make download -C projf-makefiles/hello/hello-arty/D" + TARGET="arty_35" make download -C projf-makefiles/hello/hello-arty/D diff --git a/projf-makefiles/hello/hello-arty/E/README.rst b/projf-makefiles/hello/hello-arty/E/README.rst index ef35f5e..2042de7 100644 --- a/projf-makefiles/hello/hello-arty/E/README.rst +++ b/projf-makefiles/hello/hello-arty/E/README.rst @@ -4,8 +4,8 @@ Part 2 Design E This is the first design in Hello Arty part 2. This design blinks LED 0. To build this design run the following command in the main symbiflow directory: -.. code:: bash - :name: hello-arty-E +.. code-block:: bash + :name: hello-arty-e TARGET="arty_35" make -C projf-makefiles/hello/hello-arty/E diff --git a/projf-makefiles/hello/hello-arty/F/README.rst b/projf-makefiles/hello/hello-arty/F/README.rst index db0bc77..0880071 100644 --- a/projf-makefiles/hello/hello-arty/F/README.rst +++ b/projf-makefiles/hello/hello-arty/F/README.rst @@ -4,8 +4,8 @@ Part 2 Design F This design blinks LEDs 0-3 at different frequencies. To build this design run the following command in the main symbiflow directory: -.. code:: bash - :name: hello-arty-F +.. code-block:: bash + :name: hello-arty-f TARGET="arty_35" make -C projf-makefiles/hello/hello-arty/F diff --git a/projf-makefiles/hello/hello-arty/G/README.rst b/projf-makefiles/hello/hello-arty/G/README.rst index aca0849..2f21e53 100644 --- a/projf-makefiles/hello/hello-arty/G/README.rst +++ b/projf-makefiles/hello/hello-arty/G/README.rst @@ -4,8 +4,8 @@ Part 2 Design G This design strobes leds 0-3. To build this design run the following command in the main symbiflow directory: -.. code:: bash - :name: hello-arty-G +.. code-block:: bash + :name: hello-arty-g TARGET="arty_35" make -C projf-makefiles/hello/hello-arty/G diff --git a/projf-makefiles/hello/hello-arty/H/README.rst b/projf-makefiles/hello/hello-arty/H/README.rst index 9918bf9..443e537 100644 --- a/projf-makefiles/hello/hello-arty/H/README.rst +++ b/projf-makefiles/hello/hello-arty/H/README.rst @@ -4,8 +4,8 @@ Part 2 Design H This design controls the brightness of LEDs 0-3 by using a PWM. To build this design run the following command in the main symbiflow directory: -.. code:: bash - :name: hello-arty-H +.. code-block:: bash + :name: hello-arty-h TARGET="arty_35" make -C projf-makefiles/hello/hello-arty/H diff --git a/projf-makefiles/hello/hello-arty/I/README.rst b/projf-makefiles/hello/hello-arty/I/README.rst index 60f07aa..51364ec 100644 --- a/projf-makefiles/hello/hello-arty/I/README.rst +++ b/projf-makefiles/hello/hello-arty/I/README.rst @@ -4,8 +4,8 @@ Part 2 Design I This design allows you to control the brightness of each LED on the arty board using a PWM with different duty cycles. To build this design run the following command in the main symbiflow directory: -.. code:: bash - :name: hello-arty-I +.. code-block:: bash + :name: hello-arty-i TARGET="arty_35" make -C projf-makefiles/hello/hello-arty/I diff --git a/projf-makefiles/hello/hello-arty/J/README.rst b/projf-makefiles/hello/hello-arty/J/README.rst index 2803884..dbbf230 100644 --- a/projf-makefiles/hello/hello-arty/J/README.rst +++ b/projf-makefiles/hello/hello-arty/J/README.rst @@ -4,8 +4,8 @@ Part 2 Design J This design controls the color of each of the 4 RGB LEDs on the arty using a PWM. To build this design run the following command in the main symbiflow directory: -.. code:: bash - :name: hello-arty-J +.. code-block:: bash + :name: hello-arty-j TARGET="arty_35" make -C projf-makefiles/hello/hello-arty/J diff --git a/projf-makefiles/hello/hello-arty/K/README.rst b/projf-makefiles/hello/hello-arty/K/README.rst index 56ee862..fa1f1a6 100644 --- a/projf-makefiles/hello/hello-arty/K/README.rst +++ b/projf-makefiles/hello/hello-arty/K/README.rst @@ -4,13 +4,14 @@ Part 3 Design K This is the first part of the traffic light example from project F. To build this design run the following command in the main symbiflow directory: -.. code:: bash - :name: hello-arty-K +.. code-block:: bash + :name: hello-arty-k - TARGET="arty_35" make -C projf-makefiles/hello/hello-arty/K" + TARGET="arty_35" make -C projf-makefiles/hello/hello-arty/K You can then download the bitstream by running: .. code:: bash - TARGET="arty_35" make download -C projf-makefiles/hello/hello-arty/K" + TARGET="arty_35" make download -C projf-makefiles/hello/hello-arty/K + \ No newline at end of file diff --git a/projf-makefiles/hello/hello-arty/L/README.rst b/projf-makefiles/hello/hello-arty/L/README.rst index bbc4a58..cb6b60d 100644 --- a/projf-makefiles/hello/hello-arty/L/README.rst +++ b/projf-makefiles/hello/hello-arty/L/README.rst @@ -4,13 +4,13 @@ Part 3 Design L This is the second part of the traffic light example from project F. To build this design run the following command in the main symbiflow directory: -.. code:: bash - :name: hello-arty-L +.. code-block:: bash + :name: hello-arty-l - TARGET="arty_35" make -C projf-makefiles/hello/hello-arty/L" + TARGET="arty_35" make -C projf-makefiles/hello/hello-arty/L You can then download the bitstream by running: .. code:: bash - TARGET="arty_35" make download -C projf-makefiles/hello/hello-arty/L" + TARGET="arty_35" make download -C projf-makefiles/hello/hello-arty/L