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

Order within README #168

Open
grahamperrin opened this issue Dec 6, 2020 · 3 comments
Open

Order within README #168

grahamperrin opened this issue Dec 6, 2020 · 3 comments
Labels
Accepted This feature request has been accepted and will be developed enhancement

Comments

@grahamperrin
Copy link

Current https://github.com/TeamMsgExtractor/msg-extractor/blob/d0c81b133c8e9d26af475128b53225e84cd01c3d/README.rst in a nutshell:

  • Usage
  • Error Reporting
  • Installation
  • Todo
  • Credits

From a newcomer perspective, I might have found this more useful:

  • Installation
  • Usage
  • Todo
  • Error Reporting
  • Credits
@TheElementalOfDestruction TheElementalOfDestruction added Accepted This feature request has been accepted and will be developed enhancement labels Dec 6, 2020
@TheElementalOfDestruction
Copy link
Collaborator

Redoing the readme in some shape or form has been necessary for a while now, but I have been focusing more on getting the code to work properly than get the documentation to look nice, especially since documentation is definitely not my strong suit.

@russelly
Copy link

I just stubbed my toes through using this module. Overall, it does what I want it to do. I just didn't have very good examples. I would be willing to help develop the readme.

@TheElementalOfDestruction
Copy link
Collaborator

Right now I'm actually trying to push most usage examples to the wiki where it can be organized a lot better, but I do still want to fix the readme with some basic usage examples. Any help you want to provide is appreciated

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted This feature request has been accepted and will be developed enhancement
Projects
None yet
Development

No branches or pull requests

3 participants