From d1691091040d6abe01ea765b4556f0727a4a6db1 Mon Sep 17 00:00:00 2001 From: Vitor Di Toro Date: Wed, 18 Apr 2018 11:22:19 -0300 Subject: [PATCH 1/2] Update README.md Fix Markdown tags --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2d0100d..217b17b 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ SummarizeMD is a simple Ruby script that generate summary (TOC) for an existing MD document. Each item of summary is linked to the respective section. -#Usage +# Usage - download file - open console - chmod +x summarizeMD @@ -10,7 +10,7 @@ Each item of summary is linked to the respective section. -#Output +# Output In order to preserve original file, the output of the script produce another file prepending generated summary. @@ -31,7 +31,7 @@ In order to preserve original file, the output of the script produce another fil summarized_readme.md -#Options +# Options You can launch script with some options (work in progress). @@ -47,7 +47,7 @@ Display list of available options. Display script version. -#License +# License Copyright (c) 2015 velthune From 3c573ee92fd8174a98d5796c44cfe5c58bb8b1fa Mon Sep 17 00:00:00 2001 From: Vitor Di Toro Date: Wed, 18 Apr 2018 11:27:52 -0300 Subject: [PATCH 2/2] Update README.md --- README.md | 42 +++++++++++++++++++++++------------------- 1 file changed, 23 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 217b17b..3dde0ef 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ SummarizeMD is a simple Ruby script that generate summary (TOC) for an existing MD document. Each item of summary is linked to the respective section. -# Usage +## Usage - download file - open console - chmod +x summarizeMD @@ -10,28 +10,32 @@ Each item of summary is linked to the respective section. -# Output +## Output In order to preserve original file, the output of the script produce another file prepending generated summary. - - $ls - . - .. - summarizeMD - readme.md - +```bash +$ ls + . + .. + summarizeMD + readme.md +```
- ./summarizeMD readme.md - $ls - . - .. - summarizeMD - readme.md - summarized_readme.md - +```bash +$ ./summarizeMD readme.md +``` + +```bash +$ ls + . + .. + summarizeMD + readme.md + summarized_readme.md +``` -# Options +## Options You can launch script with some options (work in progress). @@ -47,7 +51,7 @@ Display list of available options. Display script version. -# License +## License Copyright (c) 2015 velthune