Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rewrite the README #239

Open
ghickman opened this issue May 26, 2024 · 2 comments
Open

Rewrite the README #239

ghickman opened this issue May 26, 2024 · 2 comments

Comments

@ghickman
Copy link
Contributor

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
Copy link
Contributor

meshy commented Jun 2, 2024

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

@meshy
Copy link
Contributor

meshy commented Jun 2, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants