Add a README that details configuration.

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..2c2e1d6
--- /dev/null
+++ b/README
@@ -0,0 +1,37 @@
+Following the instructions posted by Stephen Worthington on the mythtvnz
+mailing list in the thread available here:
+  https://lists.archive.carbon60.com/mythtv/mythtvnz/640467
+The instructions in this README are largely based on posts from Stephen.
+
+You need to configure some things, typically by chedkcing your database.
+
+Get the suitable source_id, and this goes in
+/etc/mythtv-epg-nz/do_mhegepgsnoop.conf
+
+mysql -e "select sourceid,name,xmltvgrabber,useeit from videosource order by sourceid" mythconverg
+
+Get the suitable adapter, and this goes in
+/etc/mythtv-epg-nz/do_mhegepgsnoop.conf if you have more than one, you
+typically want to select the one which is used least often, which will
+normally be the one with the highest number.
+
+mysql -e "select cardid,parentid,videodevice,cardtype,inputname,sourceid,displayname,schedorder,livetvorder from capturecard order by videodevice,cardid" mythconverg
+
+Check the +json files under /etc/mythtv-epg-nz/xmltv-proc-nz to make sure
+they are using the same xmltvid values that you have on your system. This
+command will show your current xmltvid values:
+
+mysql -e "select chanid,channum,name,callsign,xmltvid,serviceid from channel
+order by channum+0" mythconverg
+
+If your xmltvid values are different from the +json ones, you can choose to
+change either the ones in the channel table, or the ones in the +json files,
+so that they match.  If you are not using Sky EPG as well as FreeviewHD EPG,
+you can ignore the xmltvid values in the sky-movies-xmltvids/+json file.
+
+You will most likely need to be using a UTF-8 locale, if you get an traceback
+and an error like:
+
+  UnicodeEncodeError: 'latin-1' codec can't encode character '\u0101' in position 328: ordinal not in range(256)
+
+Then that is your problem.