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

   1 WhiteStork Multilingual Dictionary ver. 0.1.0 ALPHA
   2
   3 What is WhiteStork Multilingual Dictionary
   4 ------------------------------------------
   5 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:
   6
   7 - GUI - written using GTK+ Hildon, commercial License
   8 - Engine - XDXF format parser, GPL license
   9 - Manager - thread management and GUI starting, GPL license
  10 - D-BUS wrapper - communication between GUI and Manager, LGPL license.
  11
  12 Compilation
  13 -----------
  14
  15 In order to compile this application go to the WhiteStork/trunk directory and run the following command:
  16
  17 make clean && make
  18
  19 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.
  20
  21 Installation
  22 ------------
  23
  24 In order to install the program, issue the following command:
  25
  26 make deb && make debi
  27
  28 These lines, compile the source code, create a debian package and install it onto your system.
  29
  30 Running
  31 -------
  32
  33 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
  34 The package contains two dictionaries, so you can start using our app right away.
  35
  36 Should there be any problems, please contact one of our developers via garage.maemo.org.
  37
  38
  39 Have fun using our application
  40
  41 The WhiteStork Multilingual dictionary developer's