schrum2 / EvoCraft-SCOPE

0 stars 0 forks source link

Professional README.md file #60

Closed schrum2 closed 2 years ago

schrum2 commented 2 years ago

We're at a point where this repo needs a README.md file. This is just a text file, but the md indicates that you can use markdown language: https://www.markdownguide.org/cheat-sheet/ . It's sort of like a simpler version of HTML. You can look at the raw text of the readme for the main EvoCraft repo to see how they do things there: https://github.com/real-itu/Evocraft-py

Basically, we need a readme that tells people how to use this code, and gives credit to the sources we used. It should have a link to the original EvoCraft repo, and also to NEAT-Python. It should tell them to pip install the requirements.txt, and explain the instructions in #59 for setting up the server directory (maybe we can even make a batch file that does this for them). Finally, it should recommend running python main.py --help but then also point out and explain the batch files being created in association with issue #51

alejmedinajr commented 2 years ago

The README file is now at a good starting point.