utils-code/tj.git-extras
1
0
Fork 0
mirror of https://github.com/tj/git-extras.git synced 2026-09-12 00:16:27 -04:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
tj.git-extras/man/Readme.md
Paul Wise 317e546b0a
Remove one of the documentation building tools 
The two methods build slightly different manual pages.

The Makefile based version has better headers so use it.

Automatically generate git-extras.md and index.txt when building docs.
2018-05-09 17:16:49 +08:00

689 B
Raw Permalink Blame History

How to generate documentation:

DESCRIPTION

To generate documentation:

  1. Start by filling out the 'man-template.md'

  2. Then install a program ronn. Get ronn from github.

  3. Run make:

$ make -C .. man/git-<command>.{1,html}
  1. Remember, we use the following naming convention for files:
git-<command>.html
git-<command>.1
git-<command>.md

AUTHOR

Written by Leila Muhtasib <muhtasib@gmail.com> Shell Script by Nick Lombard <github@jigsoft.co.za>

REPORTING BUGS

<https://github.com/tj/git-extras/issues>

SEE ALSO

<https://github.com/tj/git-extras>