classy-python/ccbv

Rewrite the README

Opened this issue · 2 comments

ghickman commented

As identified in #237, much of the current README feels outdated when read with fresh eyes. Both @meshy and @ghickman feel a better job can be done here.

Some ideas from me:

  • give a quick "elevator pitch" for what ccbv is, aims to do, and where it can used
  • add a contributing section which defines how to install and run locally
  • remove pretty much everything else?
meshy commented

Sounds good to me -- I'd even go so far as to move the "contributing" section into a separate doc, CONTRIBUTING.md.

  • 👍1
meshy commented

It might be a good time to rename README.markdown to README.md while we're at it.

  • 👍1