README.md in vimwiki_markdown-0.1.3 vs README.md in vimwiki_markdown-0.2.0

- old
+ new

@@ -6,23 +6,18 @@ It is currently a work in progress (but working for me ;) ## Requirements -Ruby installed on your computer +Ruby installed on your computer & up to date version of vimwiki https://www.ruby-lang.org/en/installation/ Install the vimwiki_markdown gem $ gem install vimwiki_markdown -Note, the current version of vimwiki does not allow binaries to be called -for the generation of html. This was added on the master branch in [this commit](https://github.com/vimwiki/vimwiki/commit/c1a5bb51adc8cacaa70e2804106817b68295f932) - -Currently you will need to make sure you are running the dev branch of vimwiki, or add that commit in yourself - ## Setup Ensure that your vimiwiki directive in your .vimrc is setup for markdown. For this we use the custom_wiki2html parameter. My .vimrc looks like this: @@ -61,9 +56,12 @@ A sample tpl file is available here https://raw.githubusercontent.com/patrickdavey/vimwiki_markdown/master/example_files/default.tpl ## Contributing + +Pull requests are very welcome, especially if you want to implement some of the +more interesting vimwiki links (e.g. :local etc.) 1. Fork it ( https://github.com/patrickdavey/vimwiki_markdown/fork ) 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Add some feature'`) 4. Push to the branch (`git push origin my-new-feature`)