Skip to content

[WIP] Add README.md #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
eine wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

[WIP] Add README.md #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0e8c74d
add README.md
1138-4eb Feb 22, 2019
5f1dfb7
add badges showing the size of docker images
1138-4eb Feb 22, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# SpinalHDL development environment

[![Build Status](https://img.shields.io/travis/com/SpinalHDL/docker/master.svg?longCache=true&style=flat-square&logo=travis)](https://travis-ci.com/SpinalHDL/docker/branches) [![Join the chat at https://gitter.im/SpinalHDL/SpinalHDL](https://img.shields.io/badge/chat-on%20gitter-4db797.svg?longCache=true&style=flat-square&logo=gitter&logoColor=4db797)](https://gitter.im/SpinalHDL/SpinalHDL?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

This repository contains utilities and sources to build docker images used in the [SpinalHDL GitHub organization](https://github.com/SpinalHDL).
All of them are periodically built at [travis-ci.com/spinalhdl](https://travis-ci.com/spinalhdl) and pushed to [hub.docker.com/u/spinalhdl](https://hub.docker.com/u/spinalhdl/):

- [![spinalhdl/dev pulls](https://img.shields.io/docker/pulls/spinalhdl/dev.svg?style=flat-square&logo=docker&logoColor=00acd3&label=spinalhdl/dev) ![spinalhdl/dev size](https://img.shields.io/microbadger/image-size/spinalhdl/dev/latest.svg?label=&logo=docker&logoColor=white&style=flat-square)](https://hub.docker.com/r/spinalhdl/dev/) images with development depedendencies for [SpinalHDL](https://github.com/SpinalHDL/SpinalHDL).
- `latest`:
- `ide`:

Other images based on these are:

- Generated in [SpinalHDL/SpinalHDL](https://github.com/SpinalHDL/SpinalHDL):

[![spinalhdl/spinalhdl pulls](https://img.shields.io/docker/pulls/spinalhdl/spinalhdl.svg?style=flat-square&logo=docker&logoColor=00acd3&label=spinalhdl/spinalhdl) ![spinalhdl/spinalhdl size](https://img.shields.io/microbadger/image-size/spinalhdl/spinalhdl/latest.svg?label=%20&logo=docker&logoColor=white&style=flat-square)](https://hub.docker.com/r/spinalhdl/spinalhdl/) images with ready-to-use releases of [SpinalHDL](https://github.com/SpinalHDL/SpinalHDL), along with...

[![spinalhdl/riscv pulls](https://img.shields.io/docker/pulls/spinalhdl/riscv.svg?style=flat-square&logo=docker&logoColor=00acd3&label=spinalhdl/riscv) ![spinalhdl/riscv size](https://img.shields.io/microbadger/image-size/spinalhdl/riscv/latest.svg?label=%20&logo=docker&logoColor=white&style=flat-square)](https://hub.docker.com/r/spinalhdl/riscv/) images with ready-to-use releases of [SpinalHDL](https://github.com/SpinalHDL/SpinalHDL), along with all the dependencies (including the software toolchain for RISCV).

---

See [USE_CASES.md](./USE_CASES.md) if you are looking for usage examples from a user perspective.