utils-code/tj.git-extras
1
0
Fork 0
mirror of https://github.com/tj/git-extras.git synced 2026-09-15 18:06:24 -04:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #195 from carlcasbolt/patch-1

Browse source 
Updated readme of man pages.
This commit is contained in:
hemanth.hm 2014-07-09 11:18:03 +05:30
parent b200552c90 82466d2a52
commit a9bad79e98
1 changed files with 22 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
man/Readme.md
View file

@ -11,33 +11,44 @@ To generate documentation:
3) Run ronn:
$ronn <filename>.md
```
$ ronn <filename>.md
```
4) Remember, we use the following naming convention for files:
git-&lt;command&gt;.html
git-&lt;command&gt;.1
git-&lt;command&gt;.md
You'll need to rename the html file, as ronn probably inserted a 1 into the filename.
```
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
```
$ ronn git-effort.md
roff: ./git-effort.1
html: ./git-effort.1.html +man
roff: ./git-effort.1
html: ./git-effort.1.html +man
$mv git-effort.1.html git-effort.html
$ mv git-effort.1.html git-effort.html
```
## SHELL SCRIPT
Alternatively you can run the `manning-up.sh` automated shell script included in the man folder. The script will recreate the git-extras index based on the list of .md files available before it runs `ronn` against each one to generate the documents as well as renaming the generated `.html` files to their desired form.
$ ./manning-up.sh
```
$ ./manning-up.sh
```
To only (re)generate a specific .md manual template and have `.1.html` renamed to `.html` yau may also use manning-up.sh.
$ ./manning-up.sh git-info.md
```
$ ./manning-up.sh git-info.md
```
## AUTHOR