make a good readme

[lolyay270]

i want to make a good readme that is inspired from pre-existing readmes you can see a ton of these amazing readmes here

[lolyay270]

Review Request

please view from the branch where it will show all markdown correctly

I would like my reviewer to please comment on the layout and content. eg. if there are some features I should remove, add or change

Please note:

• I have included both ways to run the game (.exe and inside editor), since I am unsure of how people should do it. I can remove one if that is not the way we want it done
• I have some images that are placeholders and will be changed with the progression of our project.

[lolyay270]

Could you add a
tag to align the placeholder caption below the logo

yep can do, i was unsure of where to put it since i liked both places

just a thought, do you think the logo would look nice centered?

i have tried to get the logo to be centred in multiple html ways, but github doesnt seem to like them i might have to research specifically for github markdown

As for installation instructions, is this for all users or for us, the devs? If it's for all users who are running the deployed product then instructions should follow the process of downloading from releases! There are no builds in the git repo, that would be a waste of space. And the general playerbase should not need to clone the repo to play our game. But instructions on how to open the project in Unity is still nice to have, for users who want to see the "behind the scenes" of our game, and this could be a separate section than the general "install & run" instructions.

Thanks so much for this info, I will be adjusting the readme to fit

[lolyay270]

Request for Re-review

I have adjusted the readme to reflect the changes requested

I have also adjusted the content of the download whole project section to be hidden automatically This is so people who are unsure of what to do, dont accidentally clone the repo and get confused