doc/readme.md
branchENGINE-237
changeset 2014 4b6659d17b61
parent 2008 f93bf1fac875
child 2015 eefffcd9f781
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/doc/readme.md	Tue Aug 29 00:25:54 2017 +0200
     1.3 @@ -0,0 +1,44 @@
     1.4 +<!-- Copyright 2015-2017, pEp foundation, Switzerland
     1.5 +This file is part of the pEp Engine
     1.6 +This file may be used under the terms of the Creative Commons Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0) License
     1.7 +See CC_BY-SA.txt -->
     1.8 +
     1.9 +# Information about the pEp Engine
    1.10 +
    1.11 +# Dependencies
    1.12 +The p≡p Engine depends on the following projects:
    1.13 +
    1.14 +- run-time dependencies
    1.15 +  - One of the following OpenPGP implementations:
    1.16 +    - 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/)
    1.17 +    - a fork of NetPGP, [https://cacert.pep.foundation/dev/repos/netpgp-et/](https://cacert.pep.foundation/dev/repos/netpgp-et/)
    1.18 +  - a fork of libetpan, [https://github.com/fdik/libetpan](https://github.com/fdik/libetpan)
    1.19 +  - zlib (Oh yeah, where?), [http://zlib.net/](http://zlib.net/)
    1.20 +  - OpenSSL (Oh yeah, where?), [https://www.openssl.org](https://www.openssl.org)
    1.21 +  - Cyrus SASL (Oh yeah, where?), [https://www.cyrusimap.org](https://www.cyrusimap.org)
    1.22 +  - libcurl (Oh yeah, where?), [https://curl.haxx.se/libcurl/](https://curl.haxx.se/libcurl/)
    1.23 +  - libuuid, [https://www.kernel.org/pub/linux/utils/util-linux/](https://www.kernel.org/pub/linux/utils/util-linux/)
    1.24 +  - SQLite, [https://sqlite.org](https://sqlite.org)
    1.25 +- compile-time dependencies
    1.26 +  - asn1c (version v0.9.28), [http://lionet.info/asn1c/blog/](http://lionet.info/asn1c/blog/)
    1.27 +  - yml2, [https://fdik.org/yml//toolchain](https://fdik.org/yml//toolchain)
    1.28 +  - One of the following build systems:
    1.29 +    - GNU make (on Linux and macOS)
    1.30 +    - MSBuild distributed with Microsoft Visual Studio 2015 (on Windows)
    1.31 +  - One of the following compilers for C and C++:
    1.32 +    - GNU GCC (on Linux)
    1.33 +    - Apple "clang" LLVM (on MacOS)
    1.34 +    - Microsoft MSVC/MSVC++ distributed with Microsoft Visual Studio 2015 (on Windows)
    1.35 +
    1.36 +# The pEp Engine's databases
    1.37 +The p≡p Engine uses two databases:
    1.38 +`~/.pEp_management` (on *NIX) or `%LOCALAPPDATA%\pEp\management.db` on Windows, and `/usr/local/share/system.db` (on *NIX) or `%ALLUSERSPROFILE%\pEp\system.db`.
    1.39 +The latter contains the Trustwords databases.
    1.40 +
    1.41 +The management db is created by the first call of init() of p≡p Engine.
    1.42 +It does not need to be created manually.
    1.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.
    1.44 +Dictionary files for different languages are part of the p≡p Engine source distribution.
    1.45 +
    1.46 +You can test the Trustwords in `system.db` using `db/trustwords.py`.
    1.47 +Both Python tools have a `--help` switch.
    1.48 \ No newline at end of file