Added note about building and install docs

chipsenkbeil · May 28, 2019 · 226ce29 · 226ce29
1 parent 80364a9
commit 226ce29
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 6 deletions.
diff --git a/.gitignore b/.gitignore
@@ -20,3 +20,5 @@ DerivedData
 /choose
 /choose*.zip
 /choose*.tgz
+
+docs/choose.1
diff --git a/Makefile b/Makefile
@@ -1,18 +1,22 @@
-.PHONY: docs install-docs uninstall-docs
+.PHONY: docs install-docs uninstall-docs help
 VERSION = $(shell defaults read `pwd`/Info CFBundleVersion)
 APPFILE = choose
 TGZFILE = choose-$(VERSION).tgz
 ZIPFILE = choose-$(VERSION).zip
 
-release: $(TGZFILE) $(ZIPFILE)
+release: $(TGZFILE) $(ZIPFILE) ## Build release files
 
-docs:
+help: ## Display help information
+	@printf 'usage: make [target] ...\n\ntargets:\n'
+	@egrep '^(.+)\:\ .*##\ (.+)' ${MAKEFILE_LIST} | sed 's/:.*##/#/' | column -t -c 2 -s '#'
+
+docs: ## Build documentation
 	@$(MAKE) -C docs
 
-install-docs:
+install-docs: ## Install documentation
 	@$(MAKE) -C docs install
 
-uninstall-docs:
+uninstall-docs: ## Uninstall documentation
 	@$(MAKE) -C docs uninstall
 
 $(APPFILE): SDAppDelegate.m choose.xcodeproj
@@ -26,7 +30,7 @@ $(TGZFILE): $(APPFILE)
 $(ZIPFILE): $(APPFILE)
 	zip -qr $@ $<
 
-clean:
+clean: ## Remove generated files and documentation
 	rm -rf $(APPFILE) $(TGZFILE) $(ZIPFILE)
 	@$(MAKE) -C docs clean
 

diff --git a/README.md b/README.md
@@ -19,6 +19,20 @@
 $ brew install choose-gui
 ```
 
+### Build and Install Documentation
+
+From root of repository, run:
+
+```bash
+make docs
+make install-docs
+```
+
+You can then issue `man choose` to read the manual.
+
+Note that this requires `pandoc` to be installed on your system to build the
+manual page.
+
 ## Usage
 
 ```bash