1,079
edits
Difference between revisions of "TODO"
→README / Manual
(→README / Manual: more CVS -> SVN) |
|||
| Line 20: | Line 20: | ||
=== README / Manual === | === README / Manual === | ||
* | * Fingolfin has started a DocBook based manual (and FAQ, and Developer's Guide). You can find it in the SVN module "docs". It's a starting place, but very unfinished. | ||
* There is a LaTeX based version of the README in the "doc" subdir of the "scummvm" SVN 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" SVN 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. | * Everybody is welcome to start helping out with the public manual project in the "docs" SVN 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. | ||
* Maybe move all/most of the compression related stuff from our README completely to the tools README, and only leave a pointer to that in the main README. This would be beneficial because this way, it's only documented in one place; it's *completly* documented (currently, the main README doesn't mention compress_scumm_bun, for example); and people who want to use the compression tools need to download the tools package anyway. | |||
* It would be greate to have 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. | ** stuff in common/, like the config manager etc. | ||