Skip to content

Commit 3af834c

Browse files
committed
Add 'make help', and add brief build documentation
1 parent 0f9adc3 commit 3af834c

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

Makefile

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
GIT_BRANCH=`git rev-parse --abbrev-ref HEAD`
22

3-
.PHONY: all serve
3+
.PHONY: all serve help
44

5-
all:
5+
help: ## Show this help message
6+
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
7+
8+
all: ## Build the documentation under build/<git branch>
69
hugo -d build/$(GIT_BRANCH)
710

8-
serve:
11+
serve: ## Host the documentation on port 1313
912
hugo serve

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,7 @@ Style Guide](https://docs.mongodb.com/manual/meta/style-guide/).
88
## Installation Instructions
99

1010
brew install hugo mmark
11+
12+
## Building Instructions
13+
14+
make

0 commit comments

Comments
 (0)