Add dev section to README.md and update makefile to reflect new section.

pull/125/head
William Ting 12 years ago
parent f25d7ba996
commit 57053a76fa

@ -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

@ -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
-------

@ -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
Loading…
Cancel
Save