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