diff --git a/README.md b/README.md index 01014cd2ddb429bb2dc7f87c8006aceeb0362981..31eb14f235979c098f87a3c462d029029c790f05 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -This library provides an implementation of the [p≡p Engine]'s +This library provides an implementation of the [pEp Engine]'s [cryptotech] interface using [Sequoia]. - [p≡p Engine]: https://gitea.pep.foundation/pEp.foundation/pEpEngine + [pEp Engine]: https://gitea.pep.foundation/pEp.foundation/pEpEngine [cryptotech]: https://gitea.pep.foundation/pEp.foundation/pEpEngine/src/branch/master/src/cryptotech.h [Sequoia]: https://sequoia-pgp.org @@ -16,42 +16,16 @@ You can build this library as follows: ``` $ git clone https://gitea.pep.foundation/pEp.foundation/pEpEngineSequoiaBackend.git $ cd pEpEngineSequoiaBackend -$ mkdir -p /tmp/pep_engine_sequoia_backend -$ CARGO_TARGET_DIR=/tmp/pep_engine_sequoia_backend cargo build # Add --release for a release build -$ CARGO_TARGET_DIR=/tmp/pep_engine_sequoia_backend cargo test -``` - -This will generate, among others -`/tmp/pep_engine_sequoia_backend/debug/pep_engine_sequoia_backend.pc`. -This can be used to easily link to the library *in place*. That is, -no installation is required. - -Hence to build and test the engine, we can do: - -``` -$ cd ~/src/pEpEngine -$ export PKG_CONFIG_PATH=/tmp/pep_engine_sequoia_backend/debug${PKG_CONFIG_PATH+:$PKG_CONFIG_PATH} $ make -$ LD_LIBRARY_PATH=$(for p in $(pkg-config pep_engine_sequoia_backend --libs-only-L); do echo ${p#-L}; done | paste -sd ':')${LD_LIBRARY_PATH+:$LD_LIBRARY_PATH} RUST_BACKTRACE=1 make -C test test +$ make install ``` -Of course when installing the engine, we'll need to distribute the -generated library. - -Note: when profiling the library (or doing a release), be sure to -build in release mode! That is, build the library with `cargo build ---release` and replace `debug` with `release` in the second set of -commands. +To configure how this library is built, edit `local.conf`. When built in debug mode, the library always generates trace output. If you encounter problems in release mode, you can get a trace of the library's execution by setting the `PEP_TRACE` environment -variable. For example: - -``` -$ cd ~/src/pEpEngine/test -$ PKG_CONFIG_PATH=/tmp/pep_engine_sequoia_backend/debug${PKG_CONFIG_PATH+:$PKG_CONFIG_PATH} LD_LIBRARY_PATH=$(for p in $(pkg-config pep_engine_sequoia_backend --libs-only-L); do echo ${p#-L}; done | paste -sd ':')${LD_LIBRARY_PATH+:$LD_LIBRARY_PATH} PEP_TRACE=1 ./EngineTests -- --gtest_filter=DeleteKeyTest.check_delete_single_pubkey -``` +variable. ## Windows