utils-code/tj.git-extras
1
0
Fork 0
mirror of https://github.com/tj/git-extras.git synced 2026-09-10 07:26:17 -04:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
tj.git-extras/man/Readme.md
Leila Muhtasib 313d128887 Updated git-extras to include git-effort. 
Regenerated git-extras to reflect git-effort being added, and git-pull-request being removed.
Created Readme.md file on how to generate documenation.
2012-06-12 17:15:00 -04:00

890 B
Raw Blame History

How to generate documentation:

DESCRIPTION

To generate documentation:

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

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

  3. Run ronn:

    $ronn <filename>.md

  4. Remember, we use the following naming convention for files:
    git-<command>.html
    git-<command>.1
    git-<command>.md

    You'll need to rename the html file, as ronn probably inserted a 1 into the filename.

EXAMPLE

$ ronn git-effort.md

 roff: ./git-effort.1  
 html: ./git-effort.1.html                                   +man

$mv git-effort.1.html git-effort.html

AUTHOR

Written by Leila Muhtasib <muhtasib@gmail.com>

REPORTING BUGS

<http://github.com/visionmedia/git-extras/issues>

SEE ALSO

<http://github.com/visionmedia/git-extras>