Skip to content

Commit

Permalink
removed README from osflow; updated setups README (#97)
Browse files Browse the repository at this point in the history
  • Loading branch information
stnolting committed Jul 3, 2021
1 parent 0df68cf commit 1c88f03
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 51 deletions.
12 changes: 11 additions & 1 deletion setups/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,21 @@ Project maintainers may make pull requests against this repository to add or lin
| :file_folder: [`nexys-a7-test-setup`](https://github.com/stnolting/neorv32/tree/master/setups/vivado/nexys-a7-test-setup) | [Digilent Nexys 4 DDR](https://reference.digilentinc.com/reference/programmable-logic/nexys-4-ddr/start) | Xilinx Artix-7 `XC7A100TCSG324-1` | [AWenzel83](https://github.com/AWenzel83) |


### Adding Your Project Setup
## Adding Your Project Setup

Please respect the following guidelines if you'd like to add (or link) your setup to the list.

* check out the project's [code of conduct](https://github.com/stnolting/neorv32/tree/master/CODE_OF_CONDUCT.md)
* add a link if the board you are using provides online documentation (and/or can be purchased somewhere)
* use the :file_folder: emoji (`:file_folder:`) if the setup is located *in this* folder; use the :earth_africa: emoji (`:earth_africa:`) if it is a link to your local project
* please add a `README` to give some brief information about the setup and a `.gitignore` to keep things clean; take a look at [`arty-a7-35-test-setup`](https://github.com/stnolting/neorv32/setups/boards/arty-a7-35-test-setup) to get some ideas what a project setup might look like


#### Setup-Specifc NEORV32 Software Framework Modification

In order to use the features provided by the setups, minor *optional* changes can be made to the default NEORV32 setup.

* To change the default data memory size take a look at the :books: User Guide section
[_General Software Framework Setup_](https://stnolting.github.io/neorv32/ug/#_general_software_framework_setup)
* To modify the SPI flash base address for storing/booting software application see :books: User Guide section
[_Customizing the Internal Bootloader_](https://stnolting.github.io/neorv32/ug/#_customizing_the_internal_bootloader)
50 changes: 0 additions & 50 deletions setups/osflow/README.md

This file was deleted.

0 comments on commit 1c88f03

Please sign in to comment.