doc/readme.md
author Krista Bennett <krista@pep-project.org>
Wed, 06 Sep 2017 01:48:08 +0200
branch2028_fix
changeset 2035 61b05d325adc
parent 2032 97984c094070
child 2037 148b879873f8
permissions -rw-r--r--
ENGINE-246: A solution that works, but the wrong one
     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, [http://zlib.net/](http://zlib.net/)
    17   - libcurl (Only with NetPGP), [https://curl.haxx.se/libcurl/](https://curl.haxx.se/libcurl/)
    18   - libuuid, [https://www.kernel.org/pub/linux/utils/util-linux/](https://www.kernel.org/pub/linux/utils/util-linux/)
    19   - SQLite, [https://sqlite.org](https://sqlite.org)
    20 - compile-time dependencies
    21   - asn1c (version v0.9.28), [http://lionet.info/asn1c/blog/](http://lionet.info/asn1c/blog/)
    22   - yml2, [https://fdik.org/yml//toolchain](https://fdik.org/yml//toolchain)
    23   - One of the following build systems:
    24     - GNU make (on Linux and macOS)
    25     - MSBuild distributed with Microsoft Visual Studio 2015 (on Windows)
    26   - One of the following compilers for C and C++:
    27     - GNU GCC (on Linux)
    28     - Apple "clang" LLVM (on MacOS)
    29     - Microsoft MSVC/MSVC++ distributed with Microsoft Visual Studio 2015 (on Windows)
    30 
    31 # The pEp Engine's databases
    32 The p≡p Engine uses two databases:
    33 
    34 - the management database
    35   - `~/.pEp_management` on \*NIX
    36   - `%LOCALAPPDATA%\pEp\management.db` on Windows
    37 - the Trustword database
    38   - `/usr/local/share/system.db` on \*NIX
    39   - `%ALLUSERSPROFILE%\pEp\system.db` on Windows
    40 
    41 The management db is created by the first call of `init()` of p≡p Engine.
    42 It does not need to be created manually.
    43 `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.
    44 Dictionary files for different languages are part of the p≡p Engine source distribution.
    45 
    46 You can test the Trustwords in `system.db` using `db/trustwords.py`.
    47 Both Python tools have a `--help` switch.