Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
PrivyHarbor authored Sep 11, 2024
1 parent 60c6301 commit d08e3d7
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# PETAce-Solo

<!-- start-petace-solo-overview -->

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).

Expand All @@ -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.

<!-- end-petace-solo-overview -->

## Requirements

<!-- start-petace-solo-getting-started -->

| System | Toolchain |
|--------|-------------------------------------------------------|
| Linux | Clang++ (>= 5.0) or GNU G++ (>= 5.5), CMake (>= 3.15) |
Expand Down Expand Up @@ -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
```
<!-- end-petace-solo-getting-started -->

## Contribution

Expand Down

0 comments on commit d08e3d7

Please sign in to comment.