irreco/README

   1
   2
   3 Current Developers / Maintainers
   4 --------------------------------
   5 Arto Karppinen (arto.karppinen@iki.fi)
   6 Joni Kokko (t5kojo01@students.oamk.fi)
   7 Harri Vattulainen (t5vaha01@students.oamk.fi)
   8 Sami Mäki (t5masa02@students.oamk.fi)
   9 Sampo Savola (samposav@paju.oulu.fi)
  10
  11
  12 What is Irreco
  13 --------------
  14 Irreco, or Ir Remote Control, is a remote control application for Nokia tablets.
  15
  16 From user perspective, Irreco is made from end user application which allows
  17 the user to place buttons on the screen, and attach commands to those buttons.
  18 Then the user can control different thigns with irreco.
  19
  20 From programmer perspective, Irreco is made from:
  21         - UI-editor, which connects commands to buttons.
  22         - Backend api, which abstracts backend details from irreco, and irreco
  23           details from backends.
  24         - Backends, which handle different devices and give lists of supported
  25           commands
  26
  27
  28 Depencies
  29 ---------
  30 In addition of the standard Maemo stuff, Irreco needs xmlrpc:
  31
  32 Add to /etc/apt/sources.list:
  33
  34     deb http://repository.maemo.org/extras/ chinook free
  35     deb http://repository.maemo.org/extras-devel/ chinook free
  36
  37 XML RPC needs following debs to be installed:
  38
  39     gengetopt_2.18-1_armel.deb
  40     libidn11_0.6.5-1_armel.deb
  41     libidn11-dev_0.6.5-1_armel.deb
  42     libxmlrpc-c3_1.06.25-2irreco1_armel.deb
  43     libxmlrpc-c3-dev_1.06.25-2irreco1_armel.deb
  44
  45 Before those debs you must install libwww0 and libwww-dev
  46
  47 Run in terminal:
  48
  49      apt-get install libwww0
  50      apt-get install livwww-dev
  51
  52 Then install debs in following order:
  53
  54      dpkg -i gengetopt_2.18-1_armel.deb
  55      dpkg -i libidn11_0.6.5-1_armel.deb
  56      dpkg -i libidn11-dev_0.6.5-1_armel.deb
  57      dpkg -i libxmlrpc-c3_1.06.25-2irreco1_armel.deb
  58      dpkg -i libxmlrpc-c3-dev_1.06.25-2irreco1_armel.deb
  59
  60
  61
  62 Irreco project structure
  63 ------------------------
  64 irreco                  - Main irreco aplication
  65 irreco/src/api             - Irreco backend api header.
  66 irreco/src/core            - Irreco application.
  67 irreco/src/util            - Irreco util library.
  68 script                  - Scripts for testin irreco and building packages.
  69 backend                 - Irreco backends.
  70 backend/dummy           - Example / Test backend.
  71
  72
  73 Testing / Developing Irreco and backends
  74 ----------------------------------------
  75 In order to run Irreco and backends inside the Maemo development eviroment
  76 you need to ./configure both Irreco with the same --prefix and then
  77 make && install both to the same directory. Plus you need to set certain
  78 eviromental variables (PATH, LD_LIBRARY_PATH, PKG_CONFIG_PATH) so that Irreco
  79 and the Backend will find everything they need to compile & run.
  80
  81 This is pain in the ass to do manually, so i have written scripts for this
  82 purpose. To test Irreco and Lirc backend you just need to execute the following
  83 scripts:
  84
  85     ./script/irreco.sh install
  86     ./script/backend.sh lirc install
  87     ./script/test.sh run
  88
  89 The scripts will autogen, configure, make and make install everything.
  90 The installation directory is ./install in the root of the project trunk.
  91 If you need to give special options to ./configure, you can use
  92
  93      ./script/backend.sh lirc configure OPTIONS
  94
  95 For example:
  96
  97     ./script/backend.sh lirc configure --debug=yes
  98
  99 To cleanup the ./install dir you can just delete it:
 100
 101     rm -rv ./install
 102
 103 To cleanup individual backend or irreco you can run:
 104
 105     ./script/irreco.sh clean
 106     ./script/backend.sh lirc clean
 107
 108 Or to clean everything and delete ./install dir:
 109
 110     ./script/clean.sh
 111
 112
 113
 114
 115
 116
 117