Could you update the doc.txt file?

[TaurusOlson]

Hi szw,
I really like the concept of vim-ctrlspace but the fact that the documentation is updated in the README and not in the doc.txt doesn't help new users like me.
Using :help ctrlspace to have all the necessary information would be really a good thing because it wouldn't break the user's workflow (contrary to opening the README with the tables in html format).
Keep up the work.

TaurusOlson

[szw]

Yeah, you're right. I'm going to update Vim help on weekend. I agree that reading html tables as a text file is cumbersome. They are purely intended to be rendered as in the README on Github. For a Vim help text version I need to prepare something else and therefore it's not the plain Copy-Paste-Reformat case ;).

BTW, I think some general introductory sections of README are unnecessary in the doc file (like "About", "Demo", or "Installation"). Any thoughts on that?

[TaurusOlson]

Yes, I also think that these sections should stay only in the README.

• "About" may be a bit longer to be included in the help file
• the link to the video in "Demo" should be kept because the video is great and explains very well what the plugin does
• "Installation" is useless because if the user reads the help file that means that he/she has already installed the plugin

Tell me if you need some help to convert the html tables into something more human readable (reStructuredText, Markdown?)

[szw]

Ok :).

As to tables, I think Markdown has nothing besides HTML to render tables. Perhaps I will try to handle tables in a reStructuredText fashion or just replace them with plain text.