From ef4a87b87dae3fc4320c72d21a33d50b78c10e6d Mon Sep 17 00:00:00 2001 From: Dexter Plameras Date: Sat, 28 Aug 2021 16:45:50 +1000 Subject: [PATCH] Add Makefile for task automation --- Makefile | 25 +++++++++++++++++++++++++ README.md | 22 ++++------------------ contributors.md | 1 + 3 files changed, 30 insertions(+), 18 deletions(-) create mode 100644 Makefile diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..f05b586 --- /dev/null +++ b/Makefile @@ -0,0 +1,25 @@ +### HELP + +.PHONY: help +help: ## Print help + @egrep "(^### |^\S+:.*##\s)" Makefile | sed 's/^###\s*//' | sed 's/^\(\S*\)\:.*##\s*\(.*\)/ \1 - \2/' + +### DOCKER + +.PHONY: run +run: image ## docker run ... + (docker stop linux-insides-book 2>&1) > /dev/null || true + docker run --detach --rm -p 4000:4000 --name linux-insides-book --hostname linux-insides-book linux-insides-book + +.PHONY: image +image: ## docker image build ... + docker image build --rm --squash --label linux-insides --tag linux-insides-book:latest -f Dockerfile . 2> /dev/null || \ + docker image build --rm --label linux-insides --tag linux-insides-book:latest -f Dockerfile . + +### LAUNCH BROWSER + +.PHONY: browse +browse: ## Launch broweser + @timeout 60 sh -c 'until nc -z 127.0.0.1 4000; do sleep 1; done' || true + @(uname | grep Darwin > /dev/null) && open http://127.0.0.1:4000 || true + @(uname | grep Linux > /dev/null) && xdg-open http://127.0.0.1:4000 || true diff --git a/README.md b/README.md index f57963f..ca5b15b 100644 --- a/README.md +++ b/README.md @@ -63,28 +63,14 @@ In order to run your own copy of the book with gitbook within a local container: systemctl restart docker.service ``` -2. Build container image +2. Run docker image ```bash - docker image build \ - --rm --squash \ - --label linux-insides \ - --tag linux-insides-book:latest \ - -f Dockerfile . + make run ``` -3. Create and run book in local container - ```bash - docker run \ - --detach \ - --rm \ - -p 4000:4000 \ - --name linux-insides-book \ - --hostname linux-insides-book \ - linux-insides-book - ``` +3. Open your local copy of linux insides book under this url + http://localhost:4000 or run `make browse` -4. Open your local copy of linux insides book under this url - http://localhost:4000 Contributions -------------- diff --git a/contributors.md b/contributors.md index 436482e..1186eef 100644 --- a/contributors.md +++ b/contributors.md @@ -134,3 +134,4 @@ Thank you to all contributors: * [Yuxin Wu](https://github.com/chaffz) * [Biao Ding](https://github.com/SmallPond) * [Arfy slowy](https://github.com/slowy07) +* [Dexter Plameras](https://github.com/dexterp)