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

Readme and documentation completely ommit what the project is all about #1160

Closed
jovton opened this issue Jun 1, 2024 · 3 comments
Closed

Comments

@jovton
Copy link

jovton commented Jun 1, 2024

Description

Scanning through the README and the online documentation, I can't seem to find any description of what problem this project/library is supposed to solve. It talks about it being a fork from some project on codeplex (which no longer exists), and some history about the owner and organization transfer, et al, but nothing about why people should use this code. Could someone please add some introductory information to the README and documentation that properly describes what this project is all about, and what problems it solves for its users, with some example code. That would be great, thanks! :)

Example data

Used Versions

@mrbean-bremen
Copy link
Member

All true. The problem is that there is currently no one competent enough and with enough time at hand to write this documentation.
I made a PR (#1161) that slightly adapts the README (though it doesn't add any documentation), please have a look.

@jovton
Copy link
Author

jovton commented Jun 8, 2024

thank you @mrbean-bremen, your pull request addresses a reasonable amount of my concerns. i hope your PR can be approved in time! 😄

@jovton jovton closed this as completed Jun 8, 2024
@jovton
Copy link
Author

jovton commented Jun 8, 2024

README improved.

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

No branches or pull requests

2 participants