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

A good README file #50

Open
romaintailhurat opened this issue Sep 15, 2021 · 1 comment
Open

A good README file #50

romaintailhurat opened this issue Sep 15, 2021 · 1 comment

Comments

@romaintailhurat
Copy link
Contributor

We should enhance the current README with those goals in mind:

  • explain what, why, how
  • use a README "framework" (see this)
@romaintailhurat
Copy link
Contributor Author

More: we should also provide a list of features and implementation status.

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

1 participant