search

phillord / lentic

Create views of the same content in two Emacs buffers
183 stars 12 forks source link

README too simple for user #16

Closed tumashu closed 9 years ago

tumashu commented 9 years ago

README is too simple and nearly useless for end user, In my opinion, helm's README is a good example:

https://github.com/emacs-helm/helm/blob/master/README.md

phillord commented 9 years ago

I would agree that the documentation is lacking at the moment, but I think that the in package documentation is the way to go. The README.md could do with a little more on how to install, but I was not planning on adding more than that.

tumashu commented 9 years ago

I think it should include:

  1. description
  2. how to install + example
  3. how to simple configure + example
phillord commented 9 years ago

I'll add the install docs. The rest of the documentation is hyperlinked.

tumashu commented 9 years ago

ok, i suggest add example, which is more useful than words.

phillord commented 9 years ago

Going to close this now, as I have substantially improved the documentation. Please feel free to re-open if you think that the are further issues.