search

fluid-lab / gamepad-navigator

GSoC 2020 project
Other
7 stars 10 forks source link

Create better user-facing documentation. #114

Open duhrer opened 10 months ago

duhrer commented 10 months ago

Currently the docs in this repository provide a few tips for end users, but also have a lot of detail about development. It would be helpful to separate this out, perhaps into a static site associated with the project, perhaps in the wiki.

This documentation should include:

  1. Installation instructions from the app store.
  2. Manual Installation instructions for a release on GitHub.
  3. Documentation of the launcher including the default key and gamepad bindings.
  4. Instructions on opening the configuration screen, for both for the default bindings, and for the keyboard and mouse.
  5. Documentation of the configuration screen, including details on what each action does.
  6. Details on how to report problems or ask questions (need to think this through, perhaps we use a discord or matrix chat, perhaps we use GitHub discussions).
  7. The privacy policy, so that we can link to the docs instead of the page in the repo (not 100% sure on this one).