[docs] added folder README

This commit is contained in:
stnolting 2022-01-19 18:27:11 +01:00
parent bf05183d49
commit 4eb99285f0

29
docs/README.md Normal file
View file

@ -0,0 +1,29 @@
## Project Documentation
### [`datasheet`](https://github.com/stnolting/neorv32/tree/master/docs/datasheet)
AsciiDoc sources for the NEORV32 data sheet. The online version of the data sheet is
available at [https://stnolting.github.io/neorv32](https://stnolting.github.io/neorv32).
### [`figures`](https://github.com/stnolting/neorv32/tree/master/docs/figures`)
Figures and images used by the data sheet, user guide and the webpage(s). The according
license(s) are listed in [`figures/license.md`](https://github.com/stnolting/neorv32/blob/master/docs/figures/license.md).
### [`icons`](https://github.com/stnolting/neorv32/tree/master/docs/icons`)
Icons used by the data sheet and the user guide.
### [`references`](https://github.com/stnolting/neorv32/tree/master/docs/references`)
Reference material like RISC-V and Wishbone specifications.
### [`userguide`](https://github.com/stnolting/neorv32/tree/master/docs/userguide)
AsciiDoc sources for the NEORV32 user guide. The online version of the user guide is
available at [https://stnolting.github.io/neorv32/ug](https://stnolting.github.io/neorv32/ug).