Hardware
/
f4pga-examples
mirror of https://github.com/chipsalliance/f4pga-examples.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs/building-examples: move additional basys3; update heading levels 

Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
This commit is contained in:
Unai Martinez-Corral 2022-02-13 21:43:00 +01:00
parent c857098cbb
commit 1850856e3b
4 changed files with 15 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/scripts/build-examples.sh vendored
View File

@ -55,7 +55,7 @@ fi
# activate conda and enter example dir # activate conda and enter example dir
activate_env="docs/building-examples.rst:export-install-dir,fpga-fam-$fpga_family,conda-prep-env-$fpga_family,conda-act-env" activate_env="docs/building-examples.rst:export-install-dir,fpga-fam-$fpga_family,conda-prep-env-$fpga_family,conda-act-env"
snippets="${activate_env},enter-dir-$fpga_family" snippets="${activate_env},enter-dir-$fpga_family"
additionalDesigns="${activate_env},enter-dir-$fpga_family,additional_examples" additionalDesigns="${activate_env},enter-dir-$fpga_family"
# Xilinx 7-Series examples # Xilinx 7-Series examples
@ -80,7 +80,7 @@ if [ "$fpga_family" = "xc7" ]; then
#Additional examples: #Additional examples:
"button_controller") "button_controller")
snippets="${additionalDesigns} xc7/additional_examples/button_controller/README.rst:example-debouncer-basys3" snippets="${additionalDesigns} xc7/additional_examples/button_controller/README.rst:additional-examples,example-debouncer-basys3"
;; ;;
"pulse_width_led") "pulse_width_led")
snippets="${snippets} xc7/pulse_width_led/README.rst:example-pulse-arty-35t" snippets="${snippets} xc7/pulse_width_led/README.rst:example-pulse-arty-35t"

9
docs/basys3.rst Normal file
View File

@ -0,0 +1,9 @@
Additional Basys3 Examples
==========================
You can find several other exciting designs for the basys3 board in the additional_examples directory:
.. code-block:: bash
:name: additional_examples
cd additional_examples

19
docs/building-examples.rst
View File

@ -1,7 +1,7 @@
.. _Building-Examples: .. _Building-Examples:
Building example designs Building example designs
======================== ########################
Before building any example, set the installation directory to match what you Before building any example, set the installation directory to match what you
set it to earlier, for example: set it to earlier, for example:
@ -76,7 +76,7 @@ Finally, enter your working Conda environment:
Xilinx 7-Series Xilinx 7-Series
--------------- ===============
Enter the directory that contains examples for Xilinx 7-Series FPGAs: Enter the directory that contains examples for Xilinx 7-Series FPGAs:
@ -104,21 +104,8 @@ Enter the directory that contains examples for Xilinx 7-Series FPGAs:
:file: templates/example.jinja :file: templates/example.jinja
Additional Examples
-------------------
In addition to the designs we have gone over here, you can also find several other exciting designs
for the basys3 board in the additional_examples directory:
.. code-block:: bash
:name: additional_examples
cd additional_examples
QuickLogic EOS S3 QuickLogic EOS S3
----------------- =================
Enter the directory that contains examples for QuickLogic EOS S3: Enter the directory that contains examples for QuickLogic EOS S3:

1
docs/index.rst
View File

@ -49,3 +49,4 @@ currently targeting chips from multiple vendors, e.g.:
:caption: Additional example designs :caption: Additional example designs
project-f project-f
basys3