Giter Site home page Giter Site logo

Proper README is needed about whateverable HOT 6 CLOSED

raku avatar raku commented on July 23, 2024
Proper README is needed

from whateverable.

Comments (6)

JJ avatar JJ commented on July 23, 2024 1

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.

from whateverable.

AlexDaniel avatar AlexDaniel commented on July 23, 2024

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.

from whateverable.

AlexDaniel avatar AlexDaniel commented on July 23, 2024

@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.

from whateverable.

AlexDaniel avatar AlexDaniel commented on July 23, 2024

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

from whateverable.

JJ avatar JJ commented on July 23, 2024

Just in time for the Squashathon!

from whateverable.

AlexDaniel avatar AlexDaniel commented on July 23, 2024

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

from whateverable.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.