[#75] Update docs

[bmarwell]

• Add COMPILING.md or COMPILING.adoc.
• Adding an installation section to README.md.
• Linking the files from README.md instead of just mentioning them.
• Refactor out some documentation from the default readme into USAGE.adoc.
• Refactor out all the documentation from the LinuxREADME.md into COMPILING.adoc and USAGE.adoc.
• Use AsciiDoctor format for new files, because AsciiDoctor is standardized and offers better highlighting utilities for coding and technical documentation.
• Update badges.
• Update formatting.
• fixes #75 (first round, adding more files later, like CONTRIBUTING.adoc).

[Skarsnik]

Keep the usage on the Readme, even if people should check on the website. Users tend to skim through content to only find what they need, even if you put a link to the usage file. Multiple files to read confuses users. I know is not neat, but the focus is for users to find the informations they need.

I am not a fan of mentioning a specific multiworld in the doc and people probably come from these projects to find about QUsb2Snes. Also this doc is mostly a summary since all the detailed information should be on usb2snes.com

[bmarwell]

I am not a fan of mentioning a specific multiworld in the doc and people probably come from these projects to find about QUsb2Snes.

Agreed, I will change this accordingly. I added it as a search engine keyword, so people can find it more easily. But it is not needed.

Also this doc is mostly a summary since all the detailed information should be on usb2snes.com

I did not want to change this. But it is a little contradicting with

Keep the usage on the Readme, even if people should check on the website. Users tend to skim through content to only find what they need, even if you put a link to the usage file.

Anyway, I will move the usage back.

Multiple files to read confuses users. I know is not neat, but the focus is for users to find the informations they need.

Yes and no. For USERS, this is true. For Advanced Users / GitHub Users and Developers, they are comfortable with finding information in files with these names. But the target audience are probably mostly gamers, so I will move the usage back.

---

I think our ideas do not contradict themselves. I want to have a little more "standardized" document which is similar to other docs found on github. This does not mean we cannot keep the usage short as you suggested.