Updated README

README

@@ -2,9 +2,9 @@ This is a "plugin" for the Video Disk Recorder (VDR).
 
 Written by:                  Louis Braun <louis DOT braun AT gmx DOT de>
 
-Project's homepage:          URL
+Project's homepage:          http://projects.vdr-developer.org/projects/plg-tvguide 
 
-Latest version available at: URL
+Latest version available at: http://projects.vdr-developer.org/projects/plg-tvguide/files
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -15,9 +15,14 @@ See the file COPYING for more information.
 Requirements
 ------------
 
-- VDR version >= 1.7.17 (TrueColor OSD is mandatorily needed)
+- Clone Git Repository: git clone git://projects.vdr-developer.org/vdr-plugin-tvguide.git
-
+- VDR version >= 2.0.0
-- Installed ImageMagick for showing png/jpg Channel Logos and EPG Images
+- Installed ImageMagick for showing png/jpg Channel Logos, EPG Images and menu icons
+- for scaling the video picture to fit into the VDR menu window please use
+  softhddevice plugin revision 87c1c7be (2013-01-01) or newer.
+- Installed epgsearch Plugin for extended search & recording features.
+- Installed remotetimers Plugin for creating timers on a vdr server remotely from a 
+  vdr client.
 
 
 Description
@@ -28,16 +33,9 @@ Description
 Installation
 ------------
 
-After "normal" Plugin installation copy the themes from 
+After "normal" Plugin installation you have to care about the paths for the
-
+used Icons, the channel logos and epg images. The following paths can be set
-/put/your/path/here/VDR/PLUGINS/src/tvguide/themes/
+at startup:
-
-to
-
-VDRCONF/themes/
-
-Options
--------
 
 -l path, --logodir=path
     Path to the logos (Default: <vdrconfdir>/plugins/tvguide/channellogos/).
@@ -45,6 +43,31 @@ Options
 -i path, --epgimages=path
     Path to the epgimages (Default: <vdrconfdir>/plugins/tvguide/epgimages/).
 
+-c path, --icons=path
+    Path to the icons directory (Default: <ressourcedir>/plugins/tvguide/epgimages/).
+
+ResourceDirectory is taken from your VDR configuration (make.config or vdr.pc).
+
+During a "make install" the Icons are automatically copied from <PlgSourceDirectory>/icons/
+to the default path. Included Theme files are also copied from <PlgSourceDirectory>/themes/
+to <ConfigDirectory>/themes/
+
+I recommend to use channel logos from https://github.com/3PO/Senderlogos
+To download them just change in the directory you want to place the logos
+and do a:
+
+git clone https://github.com/3PO/Senderlogos.git logos
+
+An update of the logos can then be done with a "git pull" just inside this
+directory.
+
+For S2-6400 Users: Disable High Level OSD, otherwise the plugin will not be
+loaded because lack of true color support
+
+For Xine-Plugin Users: Set "Blend scaled Auto" as OSD display mode to achieve
+an suitable true color OSD.
+
+For Xineliboutput Users: Start vdr-sxfe with the --hud option enabled
 
 Usage
 -----
@@ -54,7 +77,7 @@ Remote Control Keys:
 Up/Down/Left/Right:    Navigation in the EPG grid
 Ok:                    Detailed EPG View of the selected grid
                        2nd Ok closes the detailed view
-Red:                   Set recording timer for the currently selected grid
+Red:                   Search & Recording Menu
 Green / Yellow:	       Jump (default) five channels back / forward
 Blue:                  Switch to currently selected channel
 1 / 3:                 Big jump (default 3h) back / forward in time
@@ -62,51 +85,74 @@ Blue:                  Switch to currently selected channel
 7 / 9:                 jump to previous / next prime time (8pm)
 Exit:                  closes plugin
 
+In Search & Recording menu the following options are available:
+
+- Instant Record: create a timer for the currently selected program. An
+  check for timer conflicts will be performed, if a timer conflict occurs,
+  the involved timers can be adapted to solve the conflict.
+- Delete / Edit Timer: if a timer already exists for the currently selected
+  broadcast, this timer can be deleted or edited.
+- Create Series Timer: create a periodical timer for a dedicated time on
+  dedicated days.
+- Create Search Timer: create an search timer with epgsearch. The most
+  important options can be defined directly in the menu, alternatively
+  epgsearch templates can be used to define the searchtimer options.
+- Create Switch Timer: create a switch timer for the currently selected
+  program.
+- Search: search with epgsearch
+- Search in Recordings: check if a recording already exists for the currently
+  selected program.
+- Check for Timer Conflicts: check for timer conflicts with epgsearch.
+
+The navigation through the search & recording menu can be done easily with
+up/down, left/right and the ok key. In scrolling lists, with left/right
+(after the first/last option of the displayed list element is selected) you
+jump directly to the top/bottom of the list.
 
 Setup Options
 -------------
 
-* General:
+* General Settings:
-
-- Number of Channels / Columns:				
-  Number of columns per screen (max. 8)
-  Keep in mind that the True Color OSD displays 64 Pixmaps in maximum, and each EPG
-  entry is a dedicated Pixmap. So if this value is too large, maybe not all EPG
-  information is shown on the screen.
-
-- Channel Jump (Keys Green / Yellow):
-  Number of channels to jump back / forward, counted from the currently selected
-  channel (channel to which the selected EPG entry belongs)
-
-- Time to display vertically in minutes
-  With this value the number of minutes per screen is determinated. The value is
-  an approximately value, because rounded values are used during calculation.
-  int((OSD Height - Header Height - Footer Height) / value) 
-  --> Number of Pixel for one minute
 
+- Show Main Menu Entry
+  Display "tvguide" in main menu
+- Replace VDR Schedules Menu
+  If set to "yes", the original VDR schedules menu will be replaced by tvguide
+- Theme
+- Rounded Corners
+  Use rounded corners for displayed boxes
+- Channel Jump Mode (Keys Green / Yellow)
+  select between jumping x channels back/forward or to the previous / next 
+  channel group
+- Keys Blue and OK
+  Blue: Channel Switch, Ok: Detailed EPG 
+  or
+  Blue: Detailed EPG, Ok: Channel Switch
+- Hide last Channel Group
+  If set to yes, the channels of the last channel group will not be displayed
 - Big Step (Keys 1 / 3) in hours
   Hours to jump vertically with keys 1 / 3
-
 - Huge Step (Keys 4 / 6) in hours
   Hours to jump vertically with keys 4 / 6
-
 - Time Format (12h/24h)
-  Switching between 12h and 24h time format
+- Display Reruns in detailed EPG View
 
-* Screen Layout:
+* Screen Presentation:
-
-- Theme
-  Used Theme, theme files have to be placed accordingly
-  
-- Width of left Time Column
-  Width of almost left column in Pixel
-  
-- Height of Header (Channel Logos)
-  Height of header row in Pixel
-  
-- Height of Footer (Buttons)
-  Height of footer with color buttons in Pixel
 
+- Display Mode
+  Choose between horizontal or vertical display of the channels. All further
+  width / height settings are dependend of this setting
+- Width/Height of Channel Header (% of osd width/height)
+- Width/Height of Timeline (% of osd width/height)
+- Number of Channels to display
+- Height of Footer
+- Display status header
+  - Height of status header (% of osd height/height)
+  - Scale video to upper right corner
+  - Rounded corners around video frame
+- Display Channel Names in Header
+- Display channel groups
+  - Width/Height of channel groups (% of osd width/height)
 - Show Channel Logos	
   show / hide channel logos, if logos are shown:
   - Logo Extension
@@ -115,7 +161,6 @@ Setup Options
     in Pixel
   - Logo height
     in Pixel
-	
 - Show EPG Images
   show / hide EPG images, if images are shown:
   - EPG Image width
@@ -127,6 +172,5 @@ Setup Options
 
 - Font:
   Used Font, all Fonts installed on your system are shown
-- various font sizes:
+- adjust various font sizes:
-  Size in Pixel used for described purpose
+  the defined value is added to / subtracted from the default font size
-