changeset 336:171b428ee806

Updated documentation
author Matti Hamalainen <ccr@tnsp.org>
date Thu, 22 Sep 2005 02:21:00 +0000
parents 3ea3e6f7dbcb
children 75e3fb8d706d
files INSTALL README TODO
diffstat 3 files changed, 52 insertions(+), 18 deletions(-) [+]
line wrap: on
line diff
--- a/INSTALL	Thu Sep 22 02:20:00 2005 +0000
+++ b/INSTALL	Thu Sep 22 02:21:00 2005 +0000
@@ -18,13 +18,13 @@
    * libSIDPlay2
 
   Only one emulator backend library is required, but all are
-  supported with run-time configuration. You may also need
-  some supplementary libraries for each emulator library.
+  supported with compile & run-time configuration. You may also
+  need some supplementary libraries for each emulator library.
   See below for more information.
 
 
-Emulator library selection recommendations
-==========================================
+Emulator library selection hints
+================================
 Some words on which emulation library you should choose to install
 and use - it depends somewhat on your system and personal preferences.
 
@@ -91,7 +91,7 @@
 
 http://sidplay2.sourceforge.net/
 
-You need the "sidplay-libs-2.1.0" package! Earlier versions WILL NOT
+You need the "sidplay-libs-2.1.1" package! Earlier versions WILL NOT
 WORK! Later versions MAY work, but I can't really guarantee that.
 
 
--- a/README	Thu Sep 22 02:20:00 2005 +0000
+++ b/README	Thu Sep 22 02:21:00 2005 +0000
@@ -1,7 +1,7 @@
 XMMS-SID - SIDPlay input plugin for X MultiMedia System (XMMS)
 ==============================================================
 Programmed and designed by Matti 'ccr' Hamalainen
-  (C) Copyright 1999-2004 Tecnic Software productions (TNSP)
+  (C) Copyright 1999-2005 Tecnic Software productions (TNSP)
 
 MD5 Algorithm code for song-length database handling
   by L. Peter Deutsch <ghost@aladdin.com>
@@ -54,7 +54,8 @@
   higher rate (factor * samplerate) and then downsampling with
   rate-conversion filter.
 
-  This results in smoother waveforms, BUT consumes very much CPU!
+  This results in smoother waveforms, but consumes very much CPU!
+
 
 Emu#1-tab
 ---------
--- a/TODO	Thu Sep 22 02:20:00 2005 +0000
+++ b/TODO	Thu Sep 22 02:21:00 2005 +0000
@@ -7,6 +7,16 @@
 - explain --disable-themetune in README
 - fix NEWS
 
+- XS_STIL_MAXENTRY and related problems. remove
+  hardcoded limit. best would be to unify STIL/SLDB/
+  t_xs_tuneinfo since xs_tuneinfo is dynamic. this
+  would also imply towards usefulness of XSIDB
+  (see below)
+
+  possibly just increase XS_STIL_MAXENTRY to
+  work around problems for now. rewriting the STIL/SLDB
+  junk would mean too much work for 0.8.
+
 - Subtune INFO selector does not have text when the
   fileinfo window is first opened, why?
 - Tabify filter configuration and add separate tabs
@@ -18,42 +28,61 @@
 - Clean up and re-indent the code
 - Check documentation (README, FAQ)
 
+
 For XMMS-SID v0.9/1.0
 ---------------------
+- Fileinfo "follows play" -option. If enabled, information
+  in fileinfo window is set / updated whenever tune/sub-tune
+  changes.
+
 - Editing facilities in fileinfo dialog?
   * song length
   * SID header editing
   * STIL editing is probably not sensible
 
-- XSIDB, XMMS-SID Song Information Database:
-  A combination of STIL and songlength databases, with
-  MD5 checksums (as in songlength database).
+- XSIDB, see xsidb.txt
 
   XMMS-SID could check XSIDB first and then fall back to
   STILdb and songlength db, maybe adding information to
   XSIDB if something is found.
 
+  1) read STILdb
+  2) read SLDB, combining data
+  3) save as XSIDB
+
+  Possibly it would be good to check the MD5sum always
+  and if no match, ignore the LENGTH information?
+
+  Problems:
+  - preserving field formatting (COMMENT fields especially)
+    from STIL ... is it worth it?
+
+
 - Convenience functionality?
   retrieve latest HVSC and song-length databases automatically?
   use 'curl' or 'wget' binary or use libcurl and implement
   getting of those in plugin itself. example:
 
-  0) if enabled:
+  0) If enabled:
 
-  1) get "http://www.tnsp.org/xs-files/LATEST", contents might
-     something similar to:
+  1) Get "http://www.tnsp.org/xs-files/LATEST", and
+     "http://www.tnsp.org/xs-files/LATEST.sig".
+     Contents might be something similar to:
 
 HVSC		5.8		http://...
 sldb		5.8		http://...
 stable		0.8.0		http://www.tnsp.org/xs-files/xmms-sid-0.8.0.tar.gz
 devel		0.9.0alpha0	http://www.tnsp.org/xs-files/xmms-sid-0.9.0alpha0.tar.gz
 
-  2) verify signature. tell user about xmms-sid updates and
-     ask user if he wants the HVSC/sldb updates
+  2) Verify signature. Tell user about xmms-sid updates and
+     ask user if he wants the HVSC/sldb updates.
 
-  3) if yes, download updates and verify 
+  3) If yes, download updates and verify: my gpg signatures for hvscupdate.zip
+     etc could be on tnsp.org, just get the packages themselves from
+     original distribution sites.
 
-  4) unzip, install, etc.
+  4) Unzip, install, etc... is there source for hvsc update tool? if not,
+     it may have to be reimplemented. blah.
 
   security issues:
   - how to prevent dns-spoofing or other attempts
@@ -62,7 +91,11 @@
     in xmms-sid or unzip/tar may be possible
   - only good way would be PGP/GnuPG signing of packages, but
     that might be quite hard to implement...
-   
+
+    examine libgcrypt and libgpgme to see how it's done. preferable
+    libgcrypt alone should be used, less depencies is better...
+    but if it's too hard without gpgme, use it too.
+
 
 Crazy ideas:
 - Song "pre-rendering" support+position selector