From 0e8c74ddd4de8b62d430394007d9d5a82116ae86 Mon Sep 17 00:00:00 2001 From: 1138-4EB <1138-4EB@users.noreply.github.com> Date: Fri, 22 Feb 2019 19:49:40 +0100 Subject: [PATCH 1/2] add README.md --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1d06a47 --- /dev/null +++ b/README.md @@ -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)](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)](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)](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. From 5f1dfb78dc266fe980523621c9a60060cb560c4e Mon Sep 17 00:00:00 2001 From: 1138-4EB <1138-4EB@users.noreply.github.com> Date: Fri, 22 Feb 2019 20:13:09 +0100 Subject: [PATCH 2/2] add badges showing the size of docker images --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1d06a47..57874b6 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ 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)](https://hub.docker.com/r/spinalhdl/dev/) images with development depedendencies for [SpinalHDL](https://github.com/SpinalHDL/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`: @@ -13,9 +13,9 @@ 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)](https://hub.docker.com/r/spinalhdl/spinalhdl/) images with ready-to-use releases of [SpinalHDL](https://github.com/SpinalHDL/SpinalHDL), along with... +[![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)](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). +[![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). ---