Vimjas / vim-python-pep8-indent

A nicer Python indentation style for vim.
Creative Commons Zero v1.0 Universal
790 stars 69 forks source link

Add NeoBundle / Vundle documentation to README #34

Closed bbenne10 closed 10 years ago

bbenne10 commented 10 years ago

I have added documentation on how to get this plugin working with both Vundle and NeoBundle. I have also switched the README from RST to Markdown as I couldn't get inline code blocks working in RST. (Yes - that's a silly reason to convert the entire file. I was on my lunch break, cut some slack :) ) The conversion to Markdown doesn't have to stay, but I did want to show you the process for getting this working with Vundle and NeoBundle and I assumed that having it written in markdown and easily convertable to rst was better than not having it at all.

hynek commented 10 years ago

What was your exact problem with RST inline code blocks? IOW, what did you try?

bbenne10 commented 10 years ago

The only thing I could find quickly regarding inline code blocks in RST was this. I tried this in my fork and it didn't seem like GitHub as a role for "code" and I couldn't find out what they would've used otherwise. Admittedly, I didn't look too hard. I could simply rewrite the Pathogen install instructions to move the cd command into the code block below it (and now that I've thought about it - that might be better.) I don't want the Markdown / RST thing to spark a bike shed argument. I simply wanted you to have some verbiage that you could use to document installation via NeoBundle / Vundle.

bbenne10 commented 10 years ago

I just changed back to RST in the last commit. I kept all of the other changes (with the exception of moving the cd command into the code block below and restructuring the sentence to fit that change).

This means you have both the Markdown and RST versions that you can cherry pick into master, if you'd like.

hynek commented 10 years ago

Thanks, I will mold it into something final tomorrow. :)

hynek commented 10 years ago

Thank you for your contribution!