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

Jump to bottom

Proper README is needed #26

Closed
AlexDaniel opened this issue Aug 23, 2016 · 6 comments
Closed

Proper README is needed #26

AlexDaniel opened this issue Aug 23, 2016 · 6 comments
Labels
good first issue Low-hanging fruit (relatively easy issue, good for drive-by contributions) meta Repo organization, code style, etc.

Comments

@AlexDaniel
Copy link
Member

Let's use wiki pages instead.
@AlexDaniel
Copy link
Member Author

I moved everything from README to the wiki here: https://github.com/perl6/whateverable/wiki

The text is still a bit outdated, but things will get better shortly as we test the latest version of the bots.

@AlexDaniel AlexDaniel added the all bots Issues affecting all (or most) of the bots label Sep 21, 2016
@AlexDaniel AlexDaniel added the testneeded Issue is generally resolved but tests were not written yet label Jan 6, 2017
@AlexDaniel AlexDaniel removed the testneeded Issue is generally resolved but tests were not written yet label Mar 10, 2017
@JJ
Copy link
Contributor

JJ commented Apr 22, 2017

I would vote for reopening this now. The README.md is still needed just in case one is working offline. The pointer to the wiki is kind of bare and lands you in a page with lots of links, but I can't still figure out what Whateverable actually does, other than maybe being used as a base class for bots. It would really help if a single sentence and basic usage would be included in the README.md, even if at one particular point in time it was outdated.

@JJ JJ reopened this Apr 22, 2017
@AlexDaniel
Copy link
Member Author

@MasterDuke17 By any chance, is it possible that you will write a few sentences in the readme to introduce the project and explain what it does? I've heard people saying “wtf is whateverable” many times, so having some basic info in the readme is perhaps actually needed.

@AlexDaniel AlexDaniel added meta Repo organization, code style, etc. and removed all bots Issues affecting all (or most) of the bots labels Aug 6, 2017
@AlexDaniel AlexDaniel added the good first issue Low-hanging fruit (relatively easy issue, good for drive-by contributions) label Mar 9, 2018
@AlexDaniel AlexDaniel changed the title README is outdated Proper README is needed Mar 9, 2018
@AlexDaniel
Copy link
Member Author

@JJ what about now? I've also added https://github.com/perl6/whateverable/blob/master/CONTRIBUTING.md

@JJ
Copy link
Contributor

JJ commented May 29, 2018

Just in time for the Squashathon!

@AlexDaniel
Copy link
Member Author

I'll call that good enough. Please let me know if something else should be included in it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Low-hanging fruit (relatively easy issue, good for drive-by contributions) meta Repo organization, code style, etc.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@JJ @AlexDaniel