Update QUICKSTART.md #1282
Merged
Update QUICKSTART.md #1282
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updated the output of `make help`.
|
Results evaluating commit 01bbc83 (merged with base a0d9159 as 43fd22d). See run details. PostgreSQL DB size in MB: 2854 ⇒ 2851 (-0.1% change)
expand for details... |
ZeLonewolf
reviewed
Oct 29, 2021
| make test-sql # run unit tests on the OpenMapTiles SQL schema | ||
| cat .env # list PG database and MIN_ZOOM and MAX_ZOOM information | ||
| cat quickstart.log # transcript of the last ./quickstart.sh run | ||
| make help # help about available commands |
There was a problem hiding this comment.
You know... if they're looking at this, they've already figured out what make help does! 😂
|
I think we should rework the whole system a bit to make each doc string be attached to each target. Then we won't have the problem of targets being added/deleted without being documented. .PHONY: foo
foo: ## Sample help string for the foo command
@echo "foo"
.PHONY: help
help: ## Show this help message
@awk 'BEGIN {FS = ":.*##"; printf "Usage: make \033[36m<target>\033[0m\n\nTargets:\n"} /^[a-zA-Z_-]+:.*?##/ { printf " \033[36m%-10s\033[0m %s\n", $$1, $$2 }' $(MAKEFILE_LIST)This magic command will find all make targets, and attached help strings, and print them as a nice colored table. Try copy/pasting this snippet into a |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated the output of
make help.