pylang
commented
7 years ago Nice work adding more direction in the README @Innectic. There is lack of content on the master README, which leaves the visitor wondering what CactusBot is. You helped filled this void. I'll share some opinions and suggestions:
Opinions Someone landing on any repo is likely most interested in figuring out what the project is and how to use it quickly. I think the goal of the README is to help get the visitor to their destination by redirecting or quickly answering their questions. Ex:
- What is this project?
- What can it do?
- Why do I need it?
- How do I install it?
Right now you have detailed instructions on Sepal, Cactus API and Cactusbot, with an authors section and a lengthy change log in one long TL;DR page.
Suggestions Addressing those questions above, I'd recommend:
- a one-liner description of CactusBot up front.
- give some clear visual example of what it looks like in action, showcasing its awesomeness (e.g. gif of chat commands)
- redirect installation details for the bot, Sepal and API with links to the docs. (Hopefully the installation process will be as simple as
pip install cactusbotsomeday). - highlight the Usage section, provided the installation is complete
- leave the Changelog to the docs and extract it to a separate file
- Make a simple one-liner for the Authors for brevity
Those who are intrigued by CactusBot will click the links to find out more about the project (installation, changelog, etc.). Keep it simple, but no less. Otherwise, great effort on the improving face of the project.
2Cubed
Fixes #213, and #172