search

ciaranm / securemodelines

A secure alternative to Vim modelines
107 stars 29 forks source link

Add readme #4

Closed tlvince closed 11 years ago

tlvince commented 13 years ago

Added the readme from the vim.org page in Markdown format.

ciaranm commented 13 years ago

I'm not sure that duplicating documentation is a good idea, especially if it's just for Github's sake.

tlvince commented 13 years ago

I disagree. You may have new users on GitHub expecting something to at least tell them what the project is about before they'll use it. A readme is part of the project and just good habit. Anyway, up to you! You could link back to the vim.org page if nothing else.

ciaranm commented 13 years ago

Maybe the solution's to put the documentation as a Vim help file, and include a README that just says "See doc/securemodelines.txt". Markdown-formatted documentation is completely useless to Vim, though -- Github should be adapting to the conventions of the projects it hosts, not the other way around.

mrmuskrat commented 11 years ago

As it stands now, you have no documentation on github which is a huge problem IMHO.

ciaranm commented 11 years ago

There's documentation there. The fact that Github doesn't know where to find it is a Github issue.

mrmuskrat commented 11 years ago

Really? The top of the script says: " Homepage: http://github.com/ciaranm/securemodelines

Yet, the only documentation I could find on the "homepage" for this project is in the unmerged commits in this closed issue. I know where it is but since this is the definitive source for your project so please enlighten me, how are people, most of which won't know where to look, supposed to find your documentation?

ciaranm commented 11 years ago

Hrm. That documentation used to be in a Vim-format help file. Wonder where that went.