Apple-1-HW/verilog-apple-one
1
0
Fork 0
mirror of https://github.com/alangarf/apple-one.git synced 2025-01-23 05:30:16 +00:00
Code Issues Projects Releases Wiki Activity

Add board README.md

Browse Source
This commit is contained in:
Niels Moseley 2018-02-11 22:26:09 +01:00
parent 0ed336f1f6
commit 7f18c17152
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
boards/README.md Normal file
View File

@ -0,0 +1,18 @@
## 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: <b>UPDuino_v1</b> or <b>Terasic_DE0</b>
When an extension board is required, for instance, a VGAXYZ board, the target_board_name should be something like: <b>UPDuino_v1_VGAXYZ</b>
### build_env
Choose a build_env name that uniquely identifies the development environment, such as <b>yosys</b> or <b>quartus</b> or <b>webpackISE</b> 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.