File: Readme.md

package info (click to toggle)
git-extras 7.4.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 2,120 kB
  • sloc: sh: 4,312; python: 994; makefile: 146
file content (39 lines) | stat: -rw-r--r-- 753 bytes parent folder | download | duplicates (4) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
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 &lt;<muhtasib@gmail.com>&gt;
Shell Script by Nick Lombard &lt;<github@jigsoft.co.za>&gt;

## REPORTING BUGS

&lt;<https://github.com/tj/git-extras/issues>&gt;

## SEE ALSO

&lt;<https://github.com/tj/git-extras>&gt;