diff --git a/README.md b/README.md index b57719a..b0c5ea3 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,8 @@ convert what you've just written in [Markdown](https://daringfireball.net/projec over and over for my [ArgWrap](/projects/argwrap/) extension, I decided to formally solve this problem for myself and others, creating the Md2Vim converter tool. -Md2Vim is implemented in [Golang](https://golang.org/) as a custom renderer for the -[blackfriday](https://github.com/russross/blackfriday) Markdown processor. Maintainability, ease of use, and beautiful -vimdoc output were primary considerations in its design. +Md2Vim is implemented in Golang as a custom renderer for the [blackfriday](https://github.com/russross/blackfriday) +Markdown processor. Maintainability, ease of use, and beautiful vimdoc output were primary considerations in its design. ## Installation ## @@ -25,26 +24,6 @@ Otherwise, you can use the pre-built binaries for the platforms below: * [md2vim_windows_386.zip](http://dl.foosoft.net/md2vim/md2vim_windows_386.zip) * [md2vim_windows_amd64.zip](http://dl.foosoft.net/md2vim/md2vim_windows_amd64.zip) -## Example ## - -Let's generate the documentation for [ArgWrap](/projects/argwrap/) by executing the command shown below (split into -multiple lines due to length considerations): - -``` -$ md2vim \ - -desc "Wrap and unwrap function arguments, lists, and dictionaries in Vim" \ - -cols=120 \ - README.md \ - doc/argwrap.txt -``` - -Below is an animation of the vimdoc file being generated by Md2Vim and displayed inside of Vim. The curious may also -wish to examine the [raw markdown input](https://raw.githubusercontent.com/FooSoft/vim-argwrap/master/README.md) and the -[raw vimdoc output](https://raw.githubusercontent.com/FooSoft/vim-argwrap/master/doc/argwrap.txt) used in this example -to get a better idea of how the markdown structure is transformed to vimdoc. - -![](http://foosoft.net/projects/md2vim/img/demo.gif) - ## Usage ## Executing Md2Vim with the -help command line argument will trigger online help to be displayed. The list below provides @@ -101,3 +80,8 @@ a more detailed description of what the parameters do. * **tabs** If you don't like four space tabs for some reason you can change it to something else with this parameter. + +## Screenshots ## + +[![Markdown source file](img/markdown-thumb.png)](img/markdown.png) +[![VimDoc destination file](img/vimdoc-thumb.png)](img/vimdoc.png) diff --git a/img/markdown-thumb.png b/img/markdown-thumb.png new file mode 100644 index 0000000..45fd674 Binary files /dev/null and b/img/markdown-thumb.png differ diff --git a/img/markdown.png b/img/markdown.png new file mode 100644 index 0000000..ba09967 Binary files /dev/null and b/img/markdown.png differ diff --git a/img/vimdoc-thumb.png b/img/vimdoc-thumb.png new file mode 100644 index 0000000..fa51f28 Binary files /dev/null and b/img/vimdoc-thumb.png differ diff --git a/img/vimdoc.png b/img/vimdoc.png new file mode 100644 index 0000000..de240ef Binary files /dev/null and b/img/vimdoc.png differ