diff --git a/README.md b/README.md index d901f3e..b8e29d5 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,37 @@ # OpenWRT builder -This image provides a toolchain to build OpenWRT for different hardware. +This image provides a toolchain to build OpenWRT for different hardware devices. + +## Get the docker image + +### Pre-built image + + docker pull caligari/openwrt-builder + +### From Dockerfile + + git clone git@github.com:rafacouto/docker-openwrt-builder.git + cd docker-openwrt-builder + docker build -t caligari/openwrt-builder . ## Usage --ToDo- + docker run -v $(pwd):/usr/local/openwrt/src --rm caligari/openwrt-builder + +will show the help: + + -ToDo- + +### Compile an OpenWRT version to a hardware target ## Related info - [OpenWRT wiki](https://wiki.openwrt.org/) + +## Thanks + +- [Javier Loureiro](https://twitter.com/StaticBoardsES) who has the idea for Raspberry Pi devices and provided config files for those ones. +- [OpenWRT community](https://openwrt.org/) for its great product. + +