search

Kaldaien / TZF

Tales of Zestiria "Fix" - Framerate, Render and Sound Fixes
GNU General Public License v2.0
115 stars 14 forks source link

README is useless #23

Closed ghost closed 8 years ago

ghost commented 8 years ago

The present README.md should actually be COPYING.md or LICENSE.md and something that actually describes what people are expected to do should be in README.md

magiruuvelvet commented 8 years ago

I agree to this one. This is obviously NOT a README.md

Kaldaien commented 8 years ago

It is a README, the documentation is on Steam, and that's where it is always going to stay with my projects. It'd be a complete and utter waste of my time to write documentation in two places.

This is just where source code is stored, and the license terms are all you need to know.

This is why I REPEATEDLY ask that nobody directly link to the GitHub repository. If some jerk just dropped you here with no information, they need to be reprimanded because I've flat out told people to link to the Steam Guide and thread for all support and documentation.

Kaldaien commented 8 years ago

https://steamcommunity.com/sharedfiles/filedetails/?id=542500356

ghost commented 8 years ago

As a counterpoint: You could put the documentation here and then the Steam guide can just link here. And then there wouldn't be a need to tell people to link to the Steam guide only and not this repo. Moreover, by putting the documentation here you can split it over multiple pages for readability due to Github's wiki support, as well as have on-site images for clarification and demonstration purposes.