Break down README into more informative, short pieces

[jwflory]

Hello!

Problem

When first visiting this project repository and wanting to learn more about the project, the only place where information seems to be stored is in the README file. When looking it over, it's a very long document that is difficult to discern useful information from.

Analysis

Looking through the README, it's difficult find useful information such as how to use the project, how install it, and how to get involved. It feels like it's worded more like a marketing pitch than a description of the project itself. While there is a time and place for the marketing and business proposal, the GitHub README file is probably not the best place to do this. Generally, anyone coming to the GitHub repository won't be looking for information about sponsorship - there's probably better places where that info could go. :)

One helpful tool for your project you can use is a README analyzer that will give you pointers on how you can improve your README.

Solution

You could try improving the README file by doing any of the following:

• If you want to keep the marketing-esque content in the project, consider moving the images / pitch-y sort of stuff to a wiki page.
• Try keeping your README down to the absolute minimum amount of information. This will make it easier to get through and help visitors know exactly what your project is about.
• Consider adding in short bits of information about how to install the project from the source. Be mindful of different platforms and what environments people installing might be using.
• Add a section about how to contribute to the project. Putting some bullet points about current objectives, tasks, or plans might be able to help point people in a direction. Possibly file issues for "easier" tasks that newcomers might be able to handle. Refer to them in the README.
• Adding a "Legal" section is super important so it's clear what legal guidelines and rules apply to the project, depending on whatever license you are using.

Hope some of this is helpful!