From 82466d2a5240b2c59112f9d529bdf62d2277c7c1 Mon Sep 17 00:00:00 2001 From: Carl Casbolt Date: Fri, 4 Oct 2013 10:33:29 +0100 Subject: [PATCH] Update Readme.md Cleaned up the READ file formatting a little after reading it to help the next person that is thinking of adding more documentation. --- man/Readme.md | 33 ++++++++++++++++++++++----------- 1 file changed, 22 insertions(+), 11 deletions(-) diff --git a/man/Readme.md b/man/Readme.md index 7f80314..ae22f47 100644 --- a/man/Readme.md +++ b/man/Readme.md @@ -11,33 +11,44 @@ To generate documentation: 3) Run ronn: - $ronn <filename>.md +``` +$ ronn .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. +``` +git-.html +git-.1 +git-.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