README.txt
changeset 16 db2b1da1ec91
child 37 7928e0e6eee9
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README.txt	Wed Aug 06 17:06:37 2014 +0200
     1.3 @@ -0,0 +1,60 @@
     1.4 +pEp Engine
     1.5 +==========
     1.6 +
     1.7 +0. What it is and building it
     1.8 +-----------------------------
     1.9 +
    1.10 +The pEp Engine encapsulates all real functionality of pEp.
    1.11 +It has an old style Makefile for building it.
    1.12 +
    1.13 +It supports the common targets
    1.14 +
    1.15 +$ make all
    1.16 +$ make install
    1.17 +$ make clean
    1.18 +
    1.19 +and additionally
    1.20 +
    1.21 +$ make package # for building a .tar.bz2 with the source distribution
    1.22 +
    1.23 +To build on platforms without uname(1) use BUILD_ON:
    1.24 +
    1.25 +C:\pEpEngine> :for building a .zip with a binary distribution
    1.26 +C:\pEpEngine> set BUILD_ON=Windoze && make -e windist
    1.27 +
    1.28 +1. How to cross-build
    1.29 +---------------------
    1.30 +
    1.31 +For cross-building, BUILD_FOR is being used. I.e.:
    1.32 +
    1.33 +$ BUILD_FOR=Windoze make -e windist
    1.34 +
    1.35 +Supported platforms are Darwin, Windoze, Linux.
    1.36 +
    1.37 +1. a) Cross-building for Windoze
    1.38 +................................
    1.39 +
    1.40 +Cross-building for Windoze requires mingw-w64.
    1.41 +
    1.42 +Easier linking to Visual Studio can be achieved by using Microsoft's LIB.EXE
    1.43 +tool; this command created the needed pEpEngine.lib import library:
    1.44 +
    1.45 +C:\pEpEngine> lib /def:pEpEngine.def
    1.46 +
    1.47 +2. How to build the databases
    1.48 +-----------------------------
    1.49 +
    1.50 +pEp Engine uses two databases: ~/.pEp_management (on *NIX) or
    1.51 +%LOCALAPPDATA%\pEp\management.db on Windoze respectively, and
    1.52 +/usr/local/share/system.db on *NIX or %ALLUSERSPROFILE%\pEp\system.db
    1.53 +respectively. The latter contains the safewords dbs.
    1.54 +
    1.55 +The managment db is being created by the first call of init() of pEp Engine. It
    1.56 +does not need to be created manually. system.db is being created by using the
    1.57 +DDL in db/create_system_db.sql – the content is created by db/dic2csv.py
    1.58 +out of hunspell's dictionary packages (or something similar) and then being
    1.59 +imported using sqlite3's .import command.
    1.60 +
    1.61 +You can test the safewords in system.db using db/safewords.py
    1.62 +Both Python tools have a switch --help
    1.63 +