Skip to content

Commit 7d1eecd

Browse files
Merge pull request #26 from Nancy-Chauhan/master
Add documentation for librecores-ci-openrisc docker image
2 parents 71c2ae7 + e01fa40 commit 7d1eecd

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

librecores-ci-openrisc/README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,12 @@ LibreCores CI image for OpenRISC development
33

44
[![Docker Pulls](https://img.shields.io/docker/pulls/librecores/librecores-ci-openrisc.svg)](https://hub.docker.com/r/librecores/librecores-ci-openrisc/)
55

6-
Documentation will be added later
6+
Librecores CI image for OpenRISC development is based on the standard [Librecores-CI](https://github.com/librecores/docker-images/tree/master/librecores-ci) docker image and it largely targets the [FuseSoC](https://github.com/olofk/fusesoc) use cases. This image mainly focuses on [OpenRISC](https://github.com/openrisc) project that creates a free and open processor for embedded systems.
7+
8+
### Quick Start
9+
10+
Currently librecores-ci-openrisc is successfully implemented in [mor1kx](https://github.com/openrisc/mor1kx) and [or1k-marocchino](https://github.com/Nancy-Chauhan/or1k_marocchino) projects.
11+
12+
The [or1k Continuous Integration (CI)](https://github.com/openrisc/or1k-tests) suite is running in a librecores-ci-openrisc docker container in Travis CI. Parallel execution of tests runs in librecores-ci-openrisc docker environment.
13+
14+
The librecores-ci base image includes installation of common EDA tools such as Icarus Verilog, Verilator and Yosys that is required by CI suite in openrisc projects for testing. librecores/libreocres-ci-openrisc docker image gets the toolchain required, downloads and compiles the or1k-tests.

0 commit comments

Comments
 (0)