mirror of
https://github.com/libretro/scummvm.git
synced 2025-02-21 19:51:49 +00:00
Some TODO cleanup/additions
svn-id: r16915
This commit is contained in:
parent
2e60c4fbd3
commit
ed9272ac9c
80
TODO
80
TODO
@ -22,7 +22,7 @@ request tracker for things that need work.
|
||||
|
||||
General
|
||||
========
|
||||
* Add more doxygen comments. However, quality is preferable over quantity
|
||||
* Add more Doxygen comments. However, quality is preferable over quantity
|
||||
* Add port specific user documentation (dreamcast/palm especially). That
|
||||
would include things like:
|
||||
- How to use ScummVM on system XYZ
|
||||
@ -33,61 +33,23 @@ General
|
||||
|
||||
README / Manual
|
||||
===============
|
||||
[Ender is working on a new multi-format manual/readme]
|
||||
* Ender is working on a new multi-format manual/readme.
|
||||
Since so far we haven't seen anything of that, Fingolfin has started a
|
||||
DocBook based manual (and FAQ, and Developer's Guide). You can find it in
|
||||
the CVS module "docs".
|
||||
Finally, there is a LaTeX based version of the README in the "doc" subdir
|
||||
of the "scummvm" CVS module, but it tends to slip out of sync with the
|
||||
plain text README, and it's not really a manual, it's just the README
|
||||
in a different file format.
|
||||
* Everybody is welcome to start helping out with the public manual project
|
||||
in the "docs" CVS module. You can either reuse content from the README,
|
||||
or replace it with new, better written stuff. Contact Fingolfin or our
|
||||
mailing list, scummvm-devel, if you are interested in helping out.
|
||||
* Would be nice to have a HTML version of the README on the web page (and I
|
||||
don't just mean a big <pre> section; rather I mean "real" HTML with links
|
||||
and lists and tables etc.)
|
||||
* Ideally, maybe we can convert the README to some meta format, and then from
|
||||
that generate the text README, as well as a HTML one (and maybe also PDF?)
|
||||
Some candidates:
|
||||
- DocBook
|
||||
- texinfo
|
||||
- nroff/troff + PolyglotMan (http://polyglotman.sourceforge.net/)
|
||||
- tbook (http://tbookdtd.sourceforge.net/)
|
||||
- xml2doc (http://xml2doc.sourceforge.net/)
|
||||
- ...
|
||||
* Some parts of the README probably could stand a workover. Right now the
|
||||
README is trying to be brief (it's "just" a README after all), but it really
|
||||
is the closest thing we have to a proper ScummVM manual. So either we just
|
||||
decide to turn it into a full blown manual, or maybe make a even shorter
|
||||
README, and a MANUAL with full details, examples, screen shots etc.
|
||||
* Restructure the contents of our README (our manual...) a bit. A rough and
|
||||
incomplete draft of how that might look:
|
||||
+ Introduction
|
||||
- What is ScummVM
|
||||
- History
|
||||
- Contacting the developers
|
||||
- Reporting bugs
|
||||
+ Supported Platforms
|
||||
- Windows, Linux, Mac OS X, WinCE, PalmOS, Dreamcast, ...
|
||||
One section for each, indicating basic installation & usage.
|
||||
Actually, we may not need this chapter at all, rather the
|
||||
"Installation" and "Running ScummVM" chapters might be subdivided
|
||||
as needed...
|
||||
+ Supported Games
|
||||
Here we list *all* supported games, with some information on each
|
||||
like known problems, which versions are supported precisely,
|
||||
where to get cutscene packs etc.
|
||||
+ Getting started
|
||||
- How to get ScummVM (binary, source)
|
||||
- Compiling (with more detail than now); pointer to
|
||||
the to-be-written "Developer's Guide to ScummVM"
|
||||
- First steps (basic setup, getting a first game to run)
|
||||
+ Running ScummVM
|
||||
- Command line options
|
||||
- Hot Keys
|
||||
- Savegames
|
||||
+ Configuration
|
||||
- Using the launcher
|
||||
- All config file switches in detail
|
||||
- Graphics Filters
|
||||
- Music and Sound (mostly like now; maybe under the 'Configuration' section)
|
||||
+ Glossary? (explaining abbreviations etc.)
|
||||
+ Credits
|
||||
+ Index? (would be nice, for example 'fullscreen' would link to the hotkey,
|
||||
the config file setting, and the command line option)
|
||||
* Independent of that, create a "Developer's Guide to ScummVM"
|
||||
which explains the ScummVM framework, and also the engines, i.e.
|
||||
* It would be greate to have a "Developer's Guide to ScummVM" which explains
|
||||
the ScummVM framework, and also the engines, i.e.
|
||||
- stuff in common/, like the config manager etc.
|
||||
- the backend API, and how to create new backends
|
||||
- the sound system
|
||||
@ -110,7 +72,6 @@ Web site
|
||||
If I am counting right, that should place us at about 2*(18+2+1+1+1)=46
|
||||
screenshots, compared to the current 32 (and more if we start adding HE
|
||||
games).
|
||||
* Update the 'rescumm' FAQ once 0.7.0 is out
|
||||
|
||||
#######################################################################
|
||||
# Common code, infrastructure
|
||||
@ -139,6 +100,16 @@ General
|
||||
possible to expose some of SDL's YUV overlay API as an optional part of the
|
||||
backend, but I don't know enough about it to get it to work. We'd still need
|
||||
our own implementation as a fallback, though.)
|
||||
* Make the autosave interval configurable (via GUI, command line, config file).
|
||||
* Maybe add ways to modify the game configs via the command line. E.g. allow
|
||||
./scummvm --add new_target --path=/foo monkey2
|
||||
./scummvm --remove new_target
|
||||
* Maybe allow launching games even if no target is specified? I.e. the user
|
||||
only has to specify a path (or run ScummVM from the right directory), and
|
||||
ScummVM auto-detects the game in that location
|
||||
./scummvm --auto-detect
|
||||
Of course, if we do it, it has to be done so that the launcher is still
|
||||
reachable :-)
|
||||
|
||||
Build System
|
||||
============
|
||||
@ -214,6 +185,7 @@ GUI
|
||||
all of the engines, which is not the case currently.
|
||||
Problem: It's not fully clear to me how to "best" deal with global vs. local
|
||||
settings here...
|
||||
* Maybe add the ScummVM logo (+typeface?) to the about dialog
|
||||
|
||||
Launcher
|
||||
========
|
||||
|
Loading…
x
Reference in New Issue
Block a user