mirror of
https://github.com/tj/git-extras.git
synced 2026-09-10 15:36:21 -04:00
40 lines
753 B
Markdown
40 lines
753 B
Markdown
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.](https://github.com/rtomayko/ronn)
|
|
|
|
3) Run make:
|
|
|
|
(Assumed you are under `./man` when running the command below)
|
|
|
|
```
|
|
$ make -C .. man/git-<command>.{1,html}
|
|
```
|
|
|
|
4) 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>>
|