doc/readme.md
author Damiano Boppart <damiano@pep-security.net>
Tue, 29 Aug 2017 00:56:32 +0200
branchENGINE-237
changeset 2015 eefffcd9f781
parent 2014 4b6659d17b61
child 2018 479c39e0c729
permissions -rw-r--r--
Formatting cleanup
     1 <!-- Copyright 2015-2017, pEp foundation, Switzerland
     2 This file is part of the pEp Engine
     3 This file may be used under the terms of the Creative Commons Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0) License
     4 See CC_BY-SA.txt -->
     5 
     6 # Information about the pEp Engine
     7 
     8 # Dependencies
     9 The p≡p Engine depends on the following projects:
    10 
    11 - run-time dependencies
    12   - One of the following OpenPGP implementations:
    13     - GnuPG (version 2.0.30 or 2.1.16 or newer) by way of GPGME (version 1.6.0 or newer) [https://gnupg.org/](https://gnupg.org/)
    14     - a fork of NetPGP, [https://cacert.pep.foundation/dev/repos/netpgp-et/](https://cacert.pep.foundation/dev/repos/netpgp-et/)
    15   - a fork of libetpan, [https://github.com/fdik/libetpan](https://github.com/fdik/libetpan)
    16   - zlib (Oh yeah, where?), [http://zlib.net/](http://zlib.net/)
    17   - OpenSSL (Oh yeah, where?), [https://www.openssl.org](https://www.openssl.org)
    18   - Cyrus SASL (Oh yeah, where?), [https://www.cyrusimap.org](https://www.cyrusimap.org)
    19   - libcurl (Oh yeah, where?), [https://curl.haxx.se/libcurl/](https://curl.haxx.se/libcurl/)
    20   - libuuid, [https://www.kernel.org/pub/linux/utils/util-linux/](https://www.kernel.org/pub/linux/utils/util-linux/)
    21   - SQLite, [https://sqlite.org](https://sqlite.org)
    22 - compile-time dependencies
    23   - asn1c (version v0.9.28), [http://lionet.info/asn1c/blog/](http://lionet.info/asn1c/blog/)
    24   - yml2, [https://fdik.org/yml//toolchain](https://fdik.org/yml//toolchain)
    25   - One of the following build systems:
    26     - GNU make (on Linux and macOS)
    27     - MSBuild distributed with Microsoft Visual Studio 2015 (on Windows)
    28   - One of the following compilers for C and C++:
    29     - GNU GCC (on Linux)
    30     - Apple "clang" LLVM (on MacOS)
    31     - Microsoft MSVC/MSVC++ distributed with Microsoft Visual Studio 2015 (on Windows)
    32 
    33 # The pEp Engine's databases
    34 The p≡p Engine uses two databases:
    35 
    36 - the management database
    37   - `~/.pEp_management` on \*NIX
    38   - `%LOCALAPPDATA%\pEp\management.db` on Windows
    39 - the Trustword database
    40   - `/usr/local/share/system.db` on \*NIX
    41   - `%ALLUSERSPROFILE%\pEp\system.db` on Windows
    42 
    43 The management db is created by the first call of `init()` of p≡p Engine.
    44 It does not need to be created manually.
    45 `system.db` is created by using the DDL in `db/create_system_db.sql`; the database content is created by `db/dic2csv.py` out of hunspell's dictionary packages (or something similar) and then imported using `sqlite3`'s `.import` command.
    46 Dictionary files for different languages are part of the p≡p Engine source distribution.
    47 
    48 You can test the Trustwords in `system.db` using `db/trustwords.py`.
    49 Both Python tools have a `--help` switch.