search

tygari / EVO-Idle

An idle game with an evolution theme.
5 stars 0 forks source link

Add a README #2

Closed wendorf closed 7 years ago

wendorf commented 7 years ago

It would be great to have a README.md in the root directory so people can learn about this project.

tygari commented 7 years ago

I am still learning how to use github, I only just figured out how to upload a folder. What exactly should I put in a readme file?

wendorf commented 7 years ago

At a minimum, the README should include a short project description and a link to the latest playable version of the game. If you'd like people to contribute to the codebase, you might want to add a short description of how the project is set up and what the plans for the future are, though information for contributors can also go in CONTRIBUTING.md.

mattiassingers has a good list of awesome readmes you can use as inspiration, though many of these are quite long compared to what you'll want to get started.

tygari commented 7 years ago

I will see about adding a title readme file. Thank you.

In the folder is a notes document that holds all my notes on the project. It is not the most comprehensive of pages but I felt something on my notes was better than nothing.

I am more concerned about my files being readable. I need to learn better code structure for readability.

tygari commented 7 years ago

I have added a readme file. Hope this is good enough.

wendorf commented 7 years ago

Thanks! Looks good to me. I'll close this issue now.