The apio examples package
The apio package with all the examples is called apio-examples and it is located in this repo: apio-examples. This package can be installed by means of the apio install examples command
For adding new examples follow these steps:
Fork the apio-examples repo and then clone it
Once the repo is cloned, enter into the apio-examples folder
There you will see many folder with the names of the supported boards. Find the board you want to use for your example and enter into that folder. If your board does not exist yet, create a new folder with that name
Inside your board folder you will find more folders with the names of the examples. Select the example you want to modify or creat a new folder if it is a new example
In this screenshot you can see that there are three examples inside the folder Alhambra-II
Inside the example folder there should be at least four files:
- info: It is a text file with a single line with the description of the example. Is the messages displayed whith the command apio example -l for listing all the examples
- apio.ini: Apio project file. It is created with the command apio --inti -b boardname
- A .pcf file: The constaint file with association between the top module ports and the FPGA pins
- At least one verilog file (.v)