[Scummvm-cvs-logs] CVS: scummvm TODO,1.35,1.36

Max Horn fingolfin at users.sourceforge.net
Wed Oct 29 07:04:05 CET 2003


Update of /cvsroot/scummvm/scummvm
In directory sc8-pr-cvs1:/tmp/cvs-serv15567

Modified Files:
	TODO 
Log Message:
doc TODOs

Index: TODO
===================================================================
RCS file: /cvsroot/scummvm/scummvm/TODO,v
retrieving revision 1.35
retrieving revision 1.36
diff -u -d -r1.35 -r1.36
--- TODO	27 Oct 2003 10:44:12 -0000	1.35
+++ TODO	29 Oct 2003 15:02:54 -0000	1.36
@@ -20,6 +20,21 @@
   Those are only needed internally by the plugins, and hence shouldn't be
   exported. On the long run, "midi" and "features" might be removed, too.
 
+Documentation
+=============
+* Update/enhance man page
+* 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 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.
+* Add more doxygen comments. However, quality is preferable over quantity
+
 GUI
 ===
 * Implement "tabs" for multi-pane prefs dialog





More information about the Scummvm-git-logs mailing list