adapting README
authorVolker Birk <vb@pep-project.org>
Tue, 16 Feb 2016 15:31:24 +0100
changeset 4476190f1ed4466
parent 446 b0054b40f634
child 448 a614a8dcf250
adapting README
README.txt
     1.1 --- a/README.txt	Tue Feb 09 13:46:00 2016 +0100
     1.2 +++ b/README.txt	Tue Feb 16 15:31:24 2016 +0100
     1.3 @@ -1,11 +1,43 @@
     1.4 -pEp Engine
     1.5 +p≡p Engine
     1.6  ==========
     1.7  
     1.8  0. What it is and building it
     1.9  -----------------------------
    1.10  
    1.11 -The pEp Engine encapsulates all real functionality of pEp.
    1.12 -It has an old style Makefile for building it.
    1.13 +The p≡p engine is a Free Software library encapsulating implementations of:
    1.14 +
    1.15 +- Key Management
    1.16 +
    1.17 +  Key Management in p≡p engine is based on GnuPG key chains (NetPGP on iOS).
    1.18 +  Keys are stored in an OpenPGP compatbile format and can be used for different
    1.19 +  crypto implementations.
    1.20 +
    1.21 +- Trust Rating
    1.22 +
    1.23 +  p≡p engine is sporting a two phase trust rating system. In phase one there is
    1.24 +  a rating based on channel, crypto and key security named “comm_types”. In
    1.25 +  phase 2 these are mapped to user representable values which have attached
    1.26 +  colors to present them in traffic light semantics.
    1.27 +
    1.28 +- Abstract Crypto API
    1.29 +
    1.30 +  The Abstract Crypto API is providing functions to encrypt and decrypt data or
    1.31 +  full messages without requiring an application programmer to understand the
    1.32 +  different formats and standards.
    1.33 +
    1.34 +- Message Transports
    1.35 +
    1.36 +  p≡p engine will sport a growing list of Message Transports to support any
    1.37 +  widespread text messaging system including E-Mail, SMS, XMPP and many more.
    1.38 +
    1.39 +p≡p engine is written in C99. It is not meant to be used in application code
    1.40 +directly. Instead, p≡p engine is coming together with a list of software
    1.41 +adapters for a variety of programming languages and development environments.
    1.42 +
    1.43 +p≡p engine is under Gnu General Public License v3. If you want to use it under
    1.44 +a different license, please contact mailto:council@pep.foundation.
    1.45 +
    1.46 +p≡p engine has an old style Makefile for building it.
    1.47  
    1.48  The build is configured in Makefile.conf
    1.49  
    1.50 @@ -19,44 +51,29 @@
    1.51  
    1.52  $ make package # for building a .tar.bz2 with the source distribution
    1.53  
    1.54 -To build on platforms without uname(1) use BUILD_ON:
    1.55 -
    1.56 -C:\pEpEngine> :for building a .zip with a binary distribution
    1.57 -C:\pEpEngine> set BUILD_ON=Windoze && make -e windist
    1.58 +On Windows, use Visual Studio.
    1.59  
    1.60  1. How to cross-build
    1.61  ---------------------
    1.62  
    1.63  For cross-building, BUILD_FOR is being used. I.e.:
    1.64  
    1.65 -$ BUILD_FOR=Windoze make -e windist
    1.66 -
    1.67 -Supported platforms are Darwin, Windoze, Linux.
    1.68 -
    1.69 -1. a) Cross-building for Windoze
    1.70 -................................
    1.71 -
    1.72 -Cross-building for Windoze requires mingw-w64.
    1.73 -
    1.74 -Easier linking to Visual Studio can be achieved by using Microsoft's LIB.EXE
    1.75 -tool; this command created the needed pEpEngine.lib import library:
    1.76 -
    1.77 -C:\pEpEngine> lib /def:pEpEngine.def
    1.78 +$ BUILD_FOR=yourOS make -e windist
    1.79  
    1.80  2. How to build the databases
    1.81  -----------------------------
    1.82  
    1.83 -pEp Engine uses two databases: ~/.pEp_management (on *NIX) or
    1.84 +p≡p Engine uses two databases: ~/.pEp_management (on *NIX) or
    1.85  %LOCALAPPDATA%\pEp\management.db on Windoze respectively, and
    1.86  /usr/local/share/system.db on *NIX or %ALLUSERSPROFILE%\pEp\system.db
    1.87 -respectively. The latter contains the safewords dbs.
    1.88 +respectively. The latter contains the Trustwords dbs.
    1.89  
    1.90 -The managment db is being created by the first call of init() of pEp Engine. It
    1.91 +The managment db is being created by the first call of init() of p≡p Engine. It
    1.92  does not need to be created manually. system.db is being created by using the
    1.93  DDL in db/create_system_db.sql – the content is created by db/dic2csv.py
    1.94  out of hunspell's dictionary packages (or something similar) and then being
    1.95  imported using sqlite3's .import command.
    1.96  
    1.97 -You can test the safewords in system.db using db/safewords.py
    1.98 +You can test the Trustwords in system.db using db/trustwords.py
    1.99  Both Python tools have a switch --help
   1.100