adding dependencies
authorVolker Birk <vb@pep-project.org>
Tue, 16 Feb 2016 16:02:16 +0100
changeset 448a614a8dcf250
parent 447 6190f1ed4466
child 449 c57293f2975b
adding dependencies
README.txt
     1.1 --- a/README.txt	Tue Feb 16 15:31:24 2016 +0100
     1.2 +++ b/README.txt	Tue Feb 16 16:02:16 2016 +0100
     1.3 @@ -1,8 +1,8 @@
     1.4  p≡p Engine
     1.5  ==========
     1.6  
     1.7 -0. What it is and building it
     1.8 ------------------------------
     1.9 +0. What it is
    1.10 +-------------
    1.11  
    1.12  The p≡p engine is a Free Software library encapsulating implementations of:
    1.13  
    1.14 @@ -37,6 +37,24 @@
    1.15  p≡p engine is under Gnu General Public License v3. If you want to use it under
    1.16  a different license, please contact mailto:council@pep.foundation.
    1.17  
    1.18 +
    1.19 +1. Dependencies
    1.20 +---------------
    1.21 +
    1.22 +p≡p engine is depending on the following FOSS libraries:
    1.23 +
    1.24 +libetpan, see https://github.com/fdik/libetpan
    1.25 +zlib, see http://zlib.net/
    1.26 +OpenSSL, see http://openssl.org/
    1.27 +iconv, see http://www.gnu.org/software/libiconv/
    1.28 +Cyrus SASL, see http://cyrusimap.org/
    1.29 +GnuPG via GPGME, see https://gnupg.org/
    1.30 +NetPGP/p≡p, see https://cacert.pep.foundation/dev/repos/netpgp-et/
    1.31 +
    1.32 +
    1.33 +2. Building p≡p engine
    1.34 +----------------------
    1.35 +
    1.36  p≡p engine has an old style Makefile for building it.
    1.37  
    1.38  The build is configured in Makefile.conf
    1.39 @@ -58,7 +76,8 @@
    1.40  
    1.41  For cross-building, BUILD_FOR is being used. I.e.:
    1.42  
    1.43 -$ BUILD_FOR=yourOS make -e windist
    1.44 +$ BUILD_FOR=yourOS make -e
    1.45 +
    1.46  
    1.47  2. How to build the databases
    1.48  -----------------------------
    1.49 @@ -72,7 +91,11 @@
    1.50  does not need to be created manually. system.db is being created by using the
    1.51  DDL in db/create_system_db.sql – the content is created by db/dic2csv.py
    1.52  out of hunspell's dictionary packages (or something similar) and then being
    1.53 -imported using sqlite3's .import command.
    1.54 +imported using sqlite3's .import command. Dictionary files for different
    1.55 +languages are part of p≡p engine source distribution.
    1.56 +
    1.57 +$ make db
    1.58 +$ make -C db install
    1.59  
    1.60  You can test the Trustwords in system.db using db/trustwords.py
    1.61  Both Python tools have a switch --help