tldr/Makefile

default: lint

all: setup index

index:
	@echo "WARNING!"
	@echo "Index rebuilding is deprecated."
	@echo "You should not do it, unless you understand why you doing this."
	@echo
	@TLDRHOME=`pwd` ./scripts/build_index.rb
	@echo "Index rebuilt."

setup: hooks deps

hooks:
	@cp ./scripts/pre-commit .git/hooks
	@chmod +x .git/hooks/pre-commit
	@echo "Git pre-commit hook installed."

deps:
	@bundle
	@echo "OK"

lint:
	@bundle exec mdl --style ./scripts/markdown-style.rb pages

.PHONY: default index setup hooks deps lint
Optimize make lint task 2015-12-06 16:36:44 +00:00			`default: lint`
Travis CI integration: automatic linting, rebuilding index.json, building pages archive, and little other improvements 2015-12-04 14:54:05 +00:00
Splits up Makefile. Adds all rule and phony tasks Now setup calls the deps rule that takes care of bundling RubyGem dependencies loudly. 2015-05-06 15:31:58 +01:00			`all: setup index`

feature: pages index. By having an index for the pages, it'd allow clients to build autocomplete's and show an index of pages making only one request (think `tldr list`). Subsequent caching of this file would prevent further requests. Included is a makefile to easily rebuild the index. It could be tailored in case the pages structure changed. In a particular case, the web client would benefit greatly from an index. It'd know exactly what folder a command is in and thus the number of requests would drop from 4 to 1. 2015-03-02 18:21:27 +00:00			`index:`
Remove index mention from Contributing Guidelines 2015-12-25 10:11:51 +00:00			`@echo "WARNING!"`
			`@echo "Index rebuilding is deprecated."`
			`@echo "You should not do it, unless you understand why you doing this."`
			`@echo`
refactors index building script to output JSON also removes index.md 2015-03-05 00:10:08 +00:00			@TLDRHOME=`pwd` ./scripts/build_index.rb
feature: pages index. By having an index for the pages, it'd allow clients to build autocomplete's and show an index of pages making only one request (think `tldr list`). Subsequent caching of this file would prevent further requests. Included is a makefile to easily rebuild the index. It could be tailored in case the pages structure changed. In a particular case, the web client would benefit greatly from an index. It'd know exactly what folder a command is in and thus the number of requests would drop from 4 to 1. 2015-03-02 18:21:27 +00:00			`@echo "Index rebuilt."`
Added `make setup` and a pre-commit hook to rebuild index. 2015-04-09 12:19:48 +01:00
Splits up Makefile. Adds all rule and phony tasks Now setup calls the deps rule that takes care of bundling RubyGem dependencies loudly. 2015-05-06 15:31:58 +01:00			`setup: hooks deps`

			`hooks:`
Added `make setup` and a pre-commit hook to rebuild index. 2015-04-09 12:19:48 +01:00			`@cp ./scripts/pre-commit .git/hooks`
			`@chmod +x .git/hooks/pre-commit`
			`@echo "Git pre-commit hook installed."`
Splits up Makefile. Adds all rule and phony tasks Now setup calls the deps rule that takes care of bundling RubyGem dependencies loudly. 2015-05-06 15:31:58 +01:00
			`deps:`
			`@bundle`
			`@echo "OK"`
Travis CI integration: automatic linting, rebuilding index.json, building pages archive, and little other improvements 2015-12-04 14:54:05 +00:00
Splits up Makefile. Adds all rule and phony tasks Now setup calls the deps rule that takes care of bundling RubyGem dependencies loudly. 2015-05-06 15:31:58 +01:00			`lint:`
Optimize make lint task 2015-12-06 16:36:44 +00:00			`@bundle exec mdl --style ./scripts/markdown-style.rb pages`
Travis CI integration: automatic linting, rebuilding index.json, building pages archive, and little other improvements 2015-12-04 14:54:05 +00:00
Remove lint-changed scipt, just make lint everything instead 2015-12-07 02:01:44 +00:00			`.PHONY: default index setup hooks deps lint`