diff --git a/README.md b/README.md index ac9797d..4cc0d95 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # PETAce-Solo + + PETAce-Solo is a C++ library that implements or wraps primitive cryptography schemes. It is one of the many components in [the framework PETAce](https://github.com/tiktok-privacy-innovation/PETAce). @@ -11,8 +13,12 @@ PETAce-Solo implements or wraps the following primitives that involves only one - Hashing tables: Cuckoo hashing and simple hashing. - Partially homomorphic encryption: the Paillier cryptosystem. + + ## Requirements + + | System | Toolchain | |--------|-------------------------------------------------------| | Linux | Clang++ (>= 5.0) or GNU G++ (>= 5.5), CMake (>= 3.15) | @@ -62,6 +68,7 @@ Build PETAce-Solo library with extra configuration: ```bash cmake -S . -B build -DSOLO_USE_IPCL=ON -DIPCL_DIR=${IPCL_INSTALL_DIR}/lib/cmake/ipcl-2.0.0 ``` + ## Contribution