Переглянути джерело

Add Makefile for task automation

Dexter Plameras 3 роки тому
батько
коміт
ef4a87b87d
3 змінених файлів з 30 додано та 18 видалено
  1. 25 0
      Makefile
  2. 4 18
      README.md
  3. 1 0
      contributors.md

+ 25 - 0
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

+ 4 - 18
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 
 --------------

+ 1 - 0
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)