Enrich the README

[ftomassetti]

• we need screenshots
• license
• relations with WorldEngine

[psi29a]

Honestly, I disagree here.... rather move most of the information to documentation via Sphinx. The README should be to the point and give directions to where you can find the rest, such as documentation.

[psi29a]

The documentation can be (almost always) over at read-the-docs (RTD) which will generate HTML, Latex, PDF and more for us.

[ftomassetti]

I think the README is the shop-window, so it must tell the user in 2 seconds why it should look into this project. Then all the details should stay in other places, I agree, but the README should explain what this project is (a GUI for WorldEngine, which is a world generator), under which license it is available (LGPL) and where to find the documentation. I think screenshots are extremely useful to describe what this project is in a blink.

[psi29a]

With that, I totally agree. I just meant that it shouldn't turn out like the readme for worldengine itself, that is quite large. ;)

btw: PyQT is GPL so WorldEngine-GUI is also GPL. Hope that sits well with you.

[ftomassetti]

yes, sorry my bad. I am fine with GPL for the gui