verilog-apple-one/boards/README.md

851 B

Board directory requirements

The directory structure for board should follow the following convention:

/boards/[target_board_name]/[build_env]

target_board_name

Choose a target/board name that uniquely identifies the board, including required extension boards. For example: UPDuino_v1 or Terasic_DE0

When an extension board is required, for instance, a VGAXYZ board, the target_board_name should be something like: UPDuino_v1_VGAXYZ

build_env

Choose a build_env name that uniquely identifies the development environment, such as yosys or quartus or webpackISE etc.

README.md

For each project, a README.md file should be present describing the hardware setup, the build environment and, if needed, the pinout used. Also include contact information of the maintainer.

Photos are a plus.