From af30dd19f88fa60f60b8a214c29faed711331472 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Moreira?= <3604053+cusspvz@users.noreply.github.com> Date: Mon, 10 Sep 2018 01:09:19 +0100 Subject: [PATCH 1/2] fix: readme markdown headers --- README.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index b4811d9..b594dce 100644 --- a/README.md +++ b/README.md @@ -101,37 +101,37 @@ docker run -ti --rm \ ## Available images -### 18.0.1 +### 18.0.1 -#### brcm2708-brcm2708 +#### brcm2708-brcm2708 Image Builder -> `image-builder_18.0.1_brcm2708-brcm2708` Package Builder -> `image-builder_18.0.1_brcm2708-brcm2708` -Devices: +##### Devices: - Raspberry Pi 1 - Raspberry Pi Zero - Raspberry Pi Zero W -#### brcm2708-brcm2709 +#### brcm2708-brcm2709 Image Builder -> `image-builder_18.0.1_brcm2708-brcm2709` Package Builder -> `image-builder_18.0.1_brcm2708-brcm2709` -Devices: +##### Devices: - Raspberry Pi 2 -#### brcm2708-brcm2710 +#### brcm2708-brcm2710 Image Builder -> `image-builder_18.0.1_brcm2708-brcm2710` Package Builder -> `image-builder_18.0.1_brcm2708-brcm2710` -Devices: +##### Devices: - Raspberry Pi 3 - Raspberry Pi 3B+ -#### omap-generic +#### omap-generic Image Builder -> `image-builder_18.0.1_omap-generic` Package Builder -> `image-builder_18.0.1_omap-generic` -Devices: +##### Devices: - BeagleBone Black ## Development @@ -152,12 +152,12 @@ base. Usage example: `DOCKER_USE_SUDO=1 FORCE=1 ./docker-images-builder.sh` -#### `VERBOSIFY` +#### `VERBOSIFY` Description: Shows all the underlaying command's outputs Example: `VERBOSIFY=1` -#### `TARGETS` +#### `TARGETS` Description: List of versions and targets that are meant to be built by the image builder. Each list item should contain each version and target concatened with an underscore. [ `$VERSION_$TARGET` ] @@ -165,7 +165,7 @@ Default: Defaults to all versions and targets Example: `TARGETS="18.0.1_omap-generic 18.0.1_brcm2708-brcm2708"` -#### `FORCE` +#### `FORCE` Description: This script checks if the images already exists on the registry. If this environment variable is set, it will always build and push all the version's targets. @@ -174,20 +174,20 @@ This should be used whenever there's a change on the base image. Example: `FORCE=1` -#### `DOCKER_USE_SUDO` +#### `DOCKER_USE_SUDO` Description: If you need `sudo` to run docker on your system, this should be set. Example: `DOCKER_USE_SUDO=1` -#### `DOCKER` +#### `DOCKER` Description: This is needed in case you need to change your docker binary path. Example: `DOCKER=/path/to/docker` -#### `DOCKER_USERNAME` +#### `DOCKER_USERNAME` Description: Sets the docker username in order to check if the image is already present on the registry. This also is used to prefix the image name. -#### `DOCKER_IMAGE` +#### `DOCKER_IMAGE` Description: Allows to change the docker image name. Note: If this needs to be altered, you still have to set `DOCKER_USERNAME` so the caching check works properly. Unless you're setting `FORCE`. From 75f623a267db01c35d66fad740af5b6f22d6ec88 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Moreira?= <3604053+cusspvz@users.noreply.github.com> Date: Mon, 10 Sep 2018 01:12:33 +0100 Subject: [PATCH 2/2] docs: add list styling to the available docker tags --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index b594dce..df6cb47 100644 --- a/README.md +++ b/README.md @@ -99,39 +99,39 @@ docker run -ti --rm \ ``` -## Available images +## Available docker tags ### 18.0.1 #### brcm2708-brcm2708 -Image Builder -> `image-builder_18.0.1_brcm2708-brcm2708` -Package Builder -> `image-builder_18.0.1_brcm2708-brcm2708` +- Image Builder - `cusspvz/openwrt-builder:image-builder_18.0.1_brcm2708-brcm2708` +- Package Builder - `cusspvz/openwrt-builder:image-builder_18.0.1_brcm2708-brcm2708` -##### Devices: +##### Compatible Devices: - Raspberry Pi 1 - Raspberry Pi Zero - Raspberry Pi Zero W #### brcm2708-brcm2709 -Image Builder -> `image-builder_18.0.1_brcm2708-brcm2709` -Package Builder -> `image-builder_18.0.1_brcm2708-brcm2709` +- Image Builder -> `cusspvz/openwrt-builder:image-builder_18.0.1_brcm2708-brcm2709` +- Package Builder -> `cusspvz/openwrt-builder:image-builder_18.0.1_brcm2708-brcm2709` -##### Devices: +##### Compatible Devices: - Raspberry Pi 2 #### brcm2708-brcm2710 -Image Builder -> `image-builder_18.0.1_brcm2708-brcm2710` -Package Builder -> `image-builder_18.0.1_brcm2708-brcm2710` +- Image Builder -> `cusspvz/openwrt-builder:image-builder_18.0.1_brcm2708-brcm2710` +- Package Builder -> `cusspvz/openwrt-builder:image-builder_18.0.1_brcm2708-brcm2710` -##### Devices: +##### Compatible Devices: - Raspberry Pi 3 - Raspberry Pi 3B+ #### omap-generic -Image Builder -> `image-builder_18.0.1_omap-generic` -Package Builder -> `image-builder_18.0.1_omap-generic` +- Image Builder -> `cusspvz/openwrt-builder:image-builder_18.0.1_omap-generic` +- Package Builder -> `cusspvz/openwrt-builder:image-builder_18.0.1_omap-generic` -##### Devices: +##### Compatible Devices: - BeagleBone Black ## Development