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