vcs.maemo.org Git - mdictionary/blob - README

   1 WhiteStork Multilingual Dictionary ver. 0.1.0 ALPHA
   2
   3
   4
   5 What is WhiteStork Multilingual Dictionary
   6 ------------------------------------------
   7 WhiteStork is a multilingual dictionary enabling its users to use many dictionary formats. Our final goal is to use many search engines so that different file formats could be used. They will be in a form of dynamically loadable modules. For now however, we have limited the project to one engine for the XDXF format. The application consists of four modules:
   8 - GUI - written using GTK+ Hildon, GPL License
   9 - Engine - XDXF format parser, GPL license
  10 - Manager - thread management and GUI starting, GPL license
  11 - D-BUS wrapper - communication between GUI and Manager, LGPL license.
  12
  13 Compilation
  14 -----------
  15
  16 In order to compile this application go to the WhiteStork/trunk directory and run the following command:
  17
  18 make clean && make
  19
  20 However, it is important to put out, that this will only compile the program. You won't be able to run it. Read the Installation section for information on how to install WhiteStork on your system.
  21
  22 Installation
  23 ------------
  24
  25 The first thing to do, is setting an environment variable called REP_LOCATION, to match the directory containing local svn repository. This should be done in the following way:
  26
  27 export REP_LOCATION = /local/svn/repository
  28
  29 In order to install the program, issue the following command:
  30
  31 make debs && make debs-i
  32
  33 These lines, compile the source code, create a debian package and install it onto your system.
  34
  35 Running
  36 -------
  37
  38 After installation is successful, there should a WhiteStork entry in the Extras submenu. All you have to do now is start it. Please refer to the WhiteStork User Interface Specification for hints on how to use our dictionary. It is available under this URL: https://garage.maemo.org/docman/?group_id=58
  39 The package contains two dictionaries, so you can start using our app right away.
  40
  41 Should there be any problems, please contact one of our developers via garage.maemo.org.
  42
  43
  44 Have fun using our application
  45
  46
  47 The WhiteStork Multilingual dictionary developer's
  48