From 5ac187ee4899024f979783f5b63cd363dd769fd8 Mon Sep 17 00:00:00 2001 From: Max Horn Date: Wed, 29 Oct 2003 15:02:54 +0000 Subject: doc TODOs svn-id: r11006 --- TODO | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'TODO') diff --git a/TODO b/TODO index ece5e124ec..21c3c9791f 100644 --- a/TODO +++ b/TODO @@ -20,6 +20,21 @@ General 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 
 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
-- 
cgit v1.2.3