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