Add more details to the README

Lantariel / StormProject

GNU Affero General Public License v3.0

1 stars 0 forks source link

Open pmourlanne opened 1 year ago

pmourlanne commented 1 year ago

Here are some questions I would like to see the answers to in the README:

What's the goal of this project?
Who is this project for?
Is there a features roadmap one can access?
Where can I find a running version of the code? (https://mtgstorm.fr/)
How can I contribute to the project?
Are there installation instructions, to have the code running on my machine, if I want to test / contribute?
How can I run the tests locally?

pmourlanne commented 1 year ago

This should answer some of the questions, we can take inspiration from this to write the README