search

Voxel9 / CheatX

Open-source cheat plugin for the Original Xbox.
https://voxel9.github.io/CheatX
GNU General Public License v2.0
16 stars 2 forks source link

Moving info from the readme to somewhere else #6

Closed Voxel9 closed 4 years ago

Voxel9 commented 4 years ago

Info such as usage, interface, .txt codes, etc. should be moved out of the readme and somewhere else.

The more that's added to the readme, the more bloated and ugly it's going to be to read and try to navigate through, so it needs to be put somewhere that allows splitting that info up into several parts.

Two options that come to mind are the Wiki (downside: can't access info offline), or a 'docs' folder on the repo that can be split into several .md files (downside: it's another folder to maintain)

Voxel9 commented 4 years ago

I've just spent some time splitting the readme into separate sections in a docs folder, and also managed to configure it to work with github pages. It's turned out to be even better than I anticipated!

The docs' new homes are: https://voxel9.github.io/CheatX https://github.com/Voxel9/CheatX/tree/master/docs