From 57053a76fae2f3f7f8b201cdec63516f1a8c996a Mon Sep 17 00:00:00 2001 From: William Ting Date: Sat, 12 May 2012 16:38:09 -1000 Subject: [PATCH] Add dev section to README.md and update makefile to reflect new section. --- Makefile | 2 +- README.md | 15 +++++++++++++++ docs/development.md | 11 +++++++++++ 3 files changed, 27 insertions(+), 1 deletion(-) create mode 100644 docs/development.md diff --git a/Makefile b/Makefile index 8e9c977..8900db3 100644 --- a/Makefile +++ b/Makefile @@ -11,7 +11,7 @@ uninstall: docs: pandoc -s -w man docs/manpage_header.md docs/header.md docs/body.md -o docs/autojump.1 - pandoc -s -w markdown docs/header.md docs/install.md docs/body.md -o README.md + pandoc -s -w markdown docs/header.md docs/install.md docs/development.md docs/body.md -o README.md release: # Check for tag existence diff --git a/README.md b/README.md index 7e716f4..f74adac 100644 --- a/README.md +++ b/README.md @@ -107,6 +107,21 @@ and follow on screen instructions. If you keep getting `autojump: command not found` at the prompt, do:`unset PROMPT_COMMAND`. You can also restart your shell. +DEVELOPMENT +----------- + +The source code is primarily in `./bin/autojump`. Various shell wrapper +scripts are also available in `./bin/`. + +Documentation is in various files under `./docs/`. Build documentation +with the command: + + make docs + +Unit tests are available in `./tests/`. Run unit tests with the command: + + make test + OPTIONS ------- diff --git a/docs/development.md b/docs/development.md new file mode 100644 index 0000000..6ec808f --- /dev/null +++ b/docs/development.md @@ -0,0 +1,11 @@ +## DEVELOPMENT + +The source code is primarily in `./bin/autojump`. Various shell wrapper scripts are also available in `./bin/`. + +Documentation is in various files under `./docs/`. Build documentation with the command: + + make docs + +Unit tests are available in `./tests/`. Run unit tests with the command: + + make test