Rewrite README

[chrisbrickhouse]

README.md is out of date.

• Link to ReadTheDocs instead of the wiki
• Remove link to apparently defunct FAVE Dev Group mailing list
• Add bug reporting and bug triage to section on how to contribute
• Would be nice to implement badges for:
  • License
  • Python version
  • Build pass or fail

[DerMoehre]

Hi,
I dont know, what this project is exactly about, but I would like to start contributing to python projects to get better at programming.
Is this issue still open?

Maybe it would be good to start with a documentary task :) Could some be so nice to walk me through the steps of doing so?

[chrisbrickhouse]

Hi @DerMoehre, thanks for the interest! This ticket is still open, and you're welcome to work on it. You can modify the README directly in the GitHub interface or you can use the fork-and-pull workflow which lets you work on your own computer.

The main tasks are listed in the original post, but don't feel like you need to fix the whole ticket at once. Every bit helps, so feel free to make a pull request even if you've only managed to do a few changes; you can always add more later. This also helps us review changes and catch problems earlier if you start working on more complicated parts of the program.

One final note, @JoFrhwld has the ReadTheDocs link, so you'll need to get that from him to complete the first task.

[DerMoehre]

Hi @chrisbrickhouse, thanks for the explanation :) I will try to work on this issue. If I have a question, I would reach out to you.

@JoFrhwld could you provide me with the link? :)

[DerMoehre]

I submitted a Pull-Request for the removal of the mailing group :-)

In which python version is this project written?

[chrisbrickhouse]

Joe merged the mailing group PR, I've left some feedback on your bug report PR (really cool feature, so thank you for introducing us to that!).

The project is written in Python 3.8 and tested on Python 3.8, 3.9, and 3.10. Our packages have Python 3.8+ as a dependency, but it should, in theory, work with earlier Python versions (untested).