Update docs to match current status; add myself as maintainer

3 files changed, 53 insertions, 25 deletions

diff --git a/noncore/tools/remote/README b/noncore/tools/remote/README
index 6f8a0c2..ed629c7 100644
--- a/noncore/tools/remote/README
+++ b/noncore/tools/remote/README
@@ -1,24 +1,27 @@
 opie-remote
+===========
 
-Opie-remote is a remote control emulator for the Compaq iPaq and the Sharp 
-Zaurus. It requires lirc (http://www.lirc.org) to run. There are lirc ipkgs 
-for the iPaq in the Handhelds.org feed. You must first install the
-lirc-modules-[kernel version] ipkg, and then the lirc ipkg with the
--force-depends option. The Zaurus is supported, but requires you to compile 
-from lirc's CVS. Zaurus support should be in lirc 0.6.6 and up. Check the learn
-tab in opie-remote for more detailed configuration and usage instructions.
-
-I will talk to the Open Zaurus people about providing an lirc ipkg for the
-Zaurus, but i cant make one, as i dont have a Zaurus, and cannot test it.
-
-todo:
-add a frontend for irrecord (to make it a true learning remote)
-make the UI completely user configurable (button layout, position, etc)
-ButtonDialog needs to support default remote and button settings, so what the
-button is already set to shows up.
-fix any bugs
-
-contact info:
-thomas: spiralman@softhome.net (currently the only developer)
-im also on #opie and #handhelds.org on irc.openprojects.net a lot, so look for 
-me there.
+Opie-Remote is a universal infra-red remote control application for Opie on
+handhelds such as the iPAQ and the Zaurus. It requires LIRC 
+(http://www.lirc.org) to run. There are LIRC packages for the iPAQ in the 
+Familiar feed. You must first install the kernel-module-lirc-sir package, 
+and then the lirc package. OpenZaurus should provide similar packages.
+
+Note that Opie-Remote has only been tested on an iPAQ h3800 series device.
+
+
+Todo
+----
+
+ * Split out the learning/mapping tabs to a separate config screen
+ * Make the UI completely user configurable (button layout, position, etc)
+
+
+Contact
+-------
+
+Please direct all support enquiries to the Opie users mailing list 
+(opie@handhelds.org). Developers can send patches to opie-devel@handhelds.org.
+
+Maintained by: Paul Eggleton
+Originally written by: Thomas Stephens
diff --git a/noncore/tools/remote/help_instructions b/noncore/tools/remote/help_instructions
index e52f513..21613f8 100644
--- a/noncore/tools/remote/help_instructions
+++ b/noncore/tools/remote/help_instructions
@@ -1 +1,26 @@
-<qt><h1>Opie-Remote Usage Instructions</h1><p>First, some definitions.  A Remote is a remote entry in an lircd.conf file, it represents one remote you want to emulate.  A Remote Layout is one entry in your ~/Settings/Remote.conf file.  It represents the buttons that you see on your screen.  Each button on a Remote Layout can be mapped to any button in a Remote.  This way you can have, for example, a vcr remote layout, in which all the play/pause/etc buttons are mapped to the buttons on your vcr's remote.  However, most VCR's don't have volume controls, so the volume buttons can be mapped to the volume buttons on your TV.</p><p>The first things you need the lirc and lirc-modules ipkgs.  If you installed this from an ipkg, they should already be there, thanks to the wonderful world of dependencies.  If not, get them.  The next thing you need is an lircd.conf file.  you can get these at <a href=http://www.lirc.org/>http://www.lirc.org/</a>.  Read the documentation there to figure out how to make your own, if one for your remote doesn't exist, or how to have multiple remotes in one lircd.conf file.  Once you have a good lircd.conf file, put it in /etc, kill the lircd daemon (if its running) and do a modprobe lirc_sir.  Then, run lircd again.</p><p>The next thing you want to do is to create a remote layout.  Go to the config tab, and enter a name for your remote layout in the pulldown menu. Dont use the name Remotes, as that could confuse the app.  Hopefully, that will be fixed soon.  after entering the name you want to use, press New, and then select the name again from the pulldown menu (another oddity that i hope to fix).  Then, press each button that you want to map, and a dialog should appear.  Select the remote and button that you want to use, and click OK.  Once you are done, go to the Remote tab, and select the new remote from the dropdown menu.  It should works fine.  If at any time you want to change a remote layout, go to the Config tab, select the layout from the dropdown menu, and change the buttons you want to change.</p><p>This is program is written and maintaned by Thomas (spiralman) Stephens. <a href=mailto:spiralman@softhome.net>spiralman@softhome.net</a>.  Or, look for me on #opie or #handhelds.org on irc.openprojects.net.</p></qt>");
\ No newline at end of file
+<qt><h1>Opie-Remote Usage Instructions</h1>
+
+<h2>Introduction</h2>
+
+<p>Opie-Remote allows you to learn the signals from infra-red remotes (for your TV, VCR, DVD player, etc.) and then set up a multi-function remote to control many different devices at once from your handheld.</p>
+
+<p>Each button on a Remote Layout (as seen on the main <b>Remote</b> tab) can be mapped to any button in a real remote.  This way you can have, for example, a VCR remote layout, in which all the play, pause, etc. buttons are mapped to the buttons on your VCR's remote.  However, most VCRs don't have volume controls, so the volume buttons can be mapped to the volume buttons on your TV.</p>
+
+<h2>Requirements</h2>
+
+<p>Opie-Remote requires LIRC, a handheld with supported infra-red hardware, and an appropriate LIRC driver. Your distribution should hopefully have ensured that LIRC and an appropriate driver have been installed along with this program.</p>
+
+<p>Note that currently Opie-Remote has only been tested on an iPAQ h3800 series handheld.</p>
+
+<h2>Setup</h2>
+
+<p>First, you will need to record the signals from a real remote into Opie-Remote. Go to the <b>Learn</b> tab, tap <b>Add</b> and follow the instructions.</p>
+
+<p>Secondly you need to create a remote layout. Go to the <b>Config</b> tab, and enter a name for your remote layout in the pulldown menu, then tap <b>New</b>. Then, press each button that you want to map, and a dialog should appear.  Select the remote and button that you want to use, and tap <b>OK</b>. Once you are done, go to the <b>Remote</b> tab, and select the new remote from the dropdown menu.</p>
+
+<h2>About Opie-Remote</h2>
+
+<p>Please direct all support enquiries to the Opie users mailing list (<a href=mailto:opie@handhelds.org>opie@handhelds.org</a>). Developers can send patches to <a href=mailto:opie-devel@handhelds.org>opie-devel@handhelds.org</a>.</p>
+
+<p>Maintained by: Paul Eggleton<br>
+Originally written by: Thomas Stephens</p></qt>
\ No newline at end of file
diff --git a/noncore/tools/remote/helptab.cpp b/noncore/tools/remote/helptab.cpp
index ac51e13..999d0f2 100644
--- a/noncore/tools/remote/helptab.cpp
+++ b/noncore/tools/remote/helptab.cpp
@@ -6,22 +6,22 @@ This program is free software; you can redistribute it and/or modify it under th
 License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later
 version.
 
 This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the
 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
 Public License for more details.
 
 You should have received a copy of the GNU General Public License along with this program; if not, write to the Free
 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */
 
 #include "helptab.h"
 
 HelpTab::HelpTab(QWidget *parent, const char *name):QWidget(parent, name)
 {
 	QVBoxLayout *layout = new QVBoxLayout(this);
-	QString *string = new QString("<qt><h1>Opie-Remote Usage Instructions</h1><p>First, some definitions.  A Remote is a remote entry in an lircd.conf file, it represents one remote you want to emulate.  A Remote Layout is one entry in your ~/Settings/Remote.conf file.  It represents the buttons that you see on your screen.  Each button on a Remote Layout can be mapped to any button in a Remote.  This way you can have, for example, a vcr remote layout, in which all the play/pause/etc buttons are mapped to the buttons on your vcr's remote.  However, most VCR's don't have volume controls, so the volume buttons can be mapped to the volume buttons on your TV.</p><p>The first things you need the lirc and lirc-modules ipkgs.  If you installed this from an ipkg, they should already be there, thanks to the wonderful world of dependencies.  If not, get them.  The next thing you need is an lircd.conf file.  you can get these at <a href=http://www.lirc.org/>http://www.lirc.org/</a>.  Read the documentation there to figure out how to make your own, if one for your remote doesn't exist, or how to have multiple remotes in one lircd.conf file.  Once you have a good lircd.conf file, put it in /etc, kill the lircd daemon (if its running) and do a modprobe lirc_sir.  Then, run lircd again.</p><p>The next thing you want to do is to create a remote layout.  Go to the config tab, and enter a name for your remote layout in the pulldown menu. Dont use the name Remotes, as that could confuse the app.  Hopefully, that will be fixed soon.  after entering the name you want to use, press New, and then select the name again from the pulldown menu (another oddity that i hope to fix).  Then, press each button that you want to map, and a dialog should appear.  Select the remote and button that you want to use, and click OK.  Once you are done, go to the Remote tab, and select the new remote from the dropdown menu.  It should works fine.  If at any time you want to change a remote layout, go to the Config tab, select the layout from the dropdown menu, and change the buttons you want to change.</p><p>This is program is written and maintaned by Thomas (spiralman) Stephens. <a href=mailto:spiralman@softhome.net>spiralman@softhome.net</a>.  Or, look for me on #opie or #handhelds.org on irc.openprojects.net.</p></qt>");
+	QString *string = new QString("<qt><h1>Opie-Remote Usage Instructions</h1><h2>Introduction</h2><p>Opie-Remote allows you to learn the signals from infra-red remotes (for your TV, VCR, DVD player, etc.) and then set up a multi-function remote to control many different devices at once from your handheld.</p><p>Each button on a Remote Layout (as seen on the main <b>Remote</b> tab) can be mapped to any button in a real remote.  This way you can have, for example, a VCR remote layout, in which all the play, pause, etc. buttons are mapped to the buttons on your VCR's remote.  However, most VCRs don't have volume controls, so the volume buttons can be mapped to the volume buttons on your TV.</p><h2>Requirements</h2><p>Opie-Remote requires LIRC, a handheld with supported infra-red hardware, and an appropriate LIRC driver. Your distribution should hopefully have ensured that LIRC and an appropriate driver have been installed along with this program.</p><p>Note that currently Opie-Remote has only been tested on an iPAQ h3800 series handheld.</p><h2>Setup</h2><p>First, you will need to record the signals from a real remote into Opie-Remote. Go to the <b>Learn</b> tab, tap <b>Add</b> and follow the instructions.</p><p>Secondly you need to create a remote layout. Go to the <b>Config</b> tab, and enter a name for your remote layout in the pulldown menu, then tap <b>New</b>. Then, press each button that you want to map, and a dialog should appear.  Select the remote and button that you want to use, and tap <b>OK</b>. Once you are done, go to the <b>Remote</b> tab, and select the new remote from the dropdown menu.</p><h2>About Opie-Remote</h2><p>Please direct all support enquiries to the Opie users mailing list (<a href=mailto:opie@handhelds.org>opie@handhelds.org</a>). Developers can send patches to <a href=mailto:opie-devel@handhelds.org>opie-devel@handhelds.org</a>.</p><p>Maintained by: Paul Eggleton<br>Originally written by: Thomas Stephens</p></qt>");
 	QTextView *view = new QTextView((const QString &)*string, 0,  this, "view");
 	layout->insertSpacing( -1, 5);
 	layout->insertWidget(-1, view);
 	layout->insertSpacing(-1, 5);
-}
\ No newline at end of file
+}