Skip to content

Commit

Permalink
Add dev section to README.md and update makefile to reflect new section.
Browse files Browse the repository at this point in the history
  • Loading branch information
wting committed May 13, 2012
1 parent f25d7ba commit 57053a7
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 1 deletion.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------

Expand Down
11 changes: 11 additions & 0 deletions docs/development.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 57053a7

Please sign in to comment.