Difference between revisions of "User:Criezy"
(Add plans for wiki manual) |
(→Manual Proposed Reorganisation: Add introduction section) |
||
| Line 12: | Line 12: | ||
== Manual Proposed Reorganisation == | == Manual Proposed Reorganisation == | ||
=== Introduction (on one page) === | |||
What is ScummVM? | |||
Or should we merge that with the Quick Start? | |||
=== Quick Start (on one page) === | === Quick Start (on one page) === | ||
Summary on how to: | Summary on how to: | ||
| Line 33: | Line 36: | ||
# Config file description (on one page) | # Config file description (on one page) | ||
# Tools (on one page) | # Tools (on one page) | ||
== Manual TO DO == | == Manual TO DO == | ||
# Review current manual and look for omissions (partially done) | # Review current manual and look for omissions (partially done) | ||
Revision as of 00:15, 15 July 2009
| criezy | ||
|---|---|---|
| Name | Thierry Crozat | |
| Team Member since | NaM (Not a Member) | |
| Working on | Manual | |
| Personal webpage/BLOG | - | |
| thierry.crozat (AT) yahoo.co.uk | ||
First contribution to the project: patch to add support for the mac version of BS 1 (in October 2006)
Currently working on the manual
Manual Proposed Reorganisation
Introduction (on one page)
What is ScummVM? Or should we merge that with the Quick Start?
Quick Start (on one page)
Summary on how to:
- Get and install ScummVM
- Install game for use with ScummVM
- Add Game in ScummVM
- Run Game in ScummVM
- Where to find more documentation. Where to find help (forum, IRC). How to report bugs
This should be short and well illustrated, with links to the rest of the manual for details.
Get and install ScummVM (on one page)
With detailed instructions for all platforms
Install game for use with ScummVM (on one page)
With instructions for the games that differ from the simple case described in the Quick Start (e.g. multi-CD games, mac games on non mac computers, files that need to be renamed).
Add and Run game in ScummVM (on one page)
Detailed descriptions of GUI features (e.g. search box, mass add), options, GMM, Save/Load, hotkeys, controls for portable devices...
Getting help (on one page)
Describe what to do in case of errors / crashes
Appendix
Contains technical informations that should not be needed by most users
- Command line options (on one page)
- Config file description (on one page)
- Tools (on one page)
Manual TO DO
- Review current manual and look for omissions (partially done)
- Contact other contributors
- Reorganise existing content
- Complete the Manual (there are a number of scattered TO DO to fix)
- Reflection on integration of the manual with the rest of the wiki.
- What content on Game and Platform pages?
- Compatibility (version of the games that are supported by ScummVM)
- Compatibility (games working/not working on that platform)
- Hotkeys for the game
- Control on the platform
- Installation instructions on the platform
- Do we duplicate some infos?
- Or should we link to the manual for some of these?
- What content on Game and Platform pages?