search

Raku / whateverable

🤖 Different IRC bots that operate on a bunch of prebuilt Rakudo versions
https://gist.github.com/Whateverable
GNU Affero General Public License v3.0
18 stars 14 forks source link

Proper README is needed #26

Closed AlexDaniel closed 6 years ago

AlexDaniel commented 8 years ago

Let's use wiki pages instead.

AlexDaniel commented 8 years ago

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.

JJ commented 7 years ago

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.

AlexDaniel commented 7 years ago

@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 commented 6 years ago

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

JJ commented 6 years ago

Just in time for the Squashathon!

AlexDaniel commented 6 years ago

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