README.txt
author vb
Wed, 06 Aug 2014 17:06:37 +0200
changeset 16 db2b1da1ec91
child 37 7928e0e6eee9
permissions -rw-r--r--
adding README
     1 pEp Engine
     2 ==========
     3 
     4 0. What it is and building it
     5 -----------------------------
     6 
     7 The pEp Engine encapsulates all real functionality of pEp.
     8 It has an old style Makefile for building it.
     9 
    10 It supports the common targets
    11 
    12 $ make all
    13 $ make install
    14 $ make clean
    15 
    16 and additionally
    17 
    18 $ make package # for building a .tar.bz2 with the source distribution
    19 
    20 To build on platforms without uname(1) use BUILD_ON:
    21 
    22 C:\pEpEngine> :for building a .zip with a binary distribution
    23 C:\pEpEngine> set BUILD_ON=Windoze && make -e windist
    24 
    25 1. How to cross-build
    26 ---------------------
    27 
    28 For cross-building, BUILD_FOR is being used. I.e.:
    29 
    30 $ BUILD_FOR=Windoze make -e windist
    31 
    32 Supported platforms are Darwin, Windoze, Linux.
    33 
    34 1. a) Cross-building for Windoze
    35 ................................
    36 
    37 Cross-building for Windoze requires mingw-w64.
    38 
    39 Easier linking to Visual Studio can be achieved by using Microsoft's LIB.EXE
    40 tool; this command created the needed pEpEngine.lib import library:
    41 
    42 C:\pEpEngine> lib /def:pEpEngine.def
    43 
    44 2. How to build the databases
    45 -----------------------------
    46 
    47 pEp Engine uses two databases: ~/.pEp_management (on *NIX) or
    48 %LOCALAPPDATA%\pEp\management.db on Windoze respectively, and
    49 /usr/local/share/system.db on *NIX or %ALLUSERSPROFILE%\pEp\system.db
    50 respectively. The latter contains the safewords dbs.
    51 
    52 The managment db is being created by the first call of init() of pEp Engine. It
    53 does not need to be created manually. system.db is being created by using the
    54 DDL in db/create_system_db.sql – the content is created by db/dic2csv.py
    55 out of hunspell's dictionary packages (or something similar) and then being
    56 imported using sqlite3's .import command.
    57 
    58 You can test the safewords in system.db using db/safewords.py
    59 Both Python tools have a switch --help
    60