Document usage of the LibreCores CI build image

librecores / docker-images

CI Docker Images

MIT License

19 stars 8 forks source link

Document usage of the LibreCores CI build image #14

Closed oleg-nenashev closed 5 years ago

oleg-nenashev commented 5 years ago

Currently the https://hub.docker.com/r/librecores/librecores-ci/ image is not much documented. It would be great to have some user-facing docs with few examples.

[ ] Quick Start guide: How to use this image with FuseSoC (mor1kx can be used as an example) ... and Travis
[ ] References to usage examples (mor1kx, maybe also Pipeline Library)

The docs could be also put to Read The docs https://lcci.readthedocs.io/en/latest/

CC @Nancy-Chauhan

oleg-nenashev commented 5 years ago

@wallento could you please help us with https://lcci.readthedocs.io/en/latest/ ? Is is possible to configure it to take documentation from multiple GitHub repositories?