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

improve readability of README #337

Open
RvanNieuwpoort opened this issue Feb 18, 2022 · 0 comments
Open

improve readability of README #337

RvanNieuwpoort opened this issue Feb 18, 2022 · 0 comments

Comments

@RvanNieuwpoort
Copy link

The readme immediately goes into a lot of detail, without a high-level description of what the purpose of this sofware is. There currently is only one line describing the purpose:

"Python package to analyze a GitHub or GitLab repository's compliance with the fair-software.eu recommendations."

Maybe that is clear for insiders, but for the target audience this may be to short. A bit of context on the fair principles for software, why those are useful, and how this tool helps users to implement them would be great.

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