Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,17 @@ field, getting networking to work, or instantiating a PRG or hash function.
Hopefully, by using SCL, researches (and hobbyists) will find it a lot easier,
and quicker!, to implement MPC protocols.

## Building SCL
### Disclaimer

SCL is distributed under the GNU Affero General Public License, for details,
refer to `LICENSE` or [https://www.gnu.org/licenses/](https://www.gnu.org/licenses/).

This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE.


# Building SCL

SCL has no external dependencies, except if you want to build the unittests. In
that case, [catch2](https://github.com/catchorg/Catch2/tree/v2.x) is required as
Expand All @@ -37,14 +47,14 @@ after the build command. By default, headers are install in `usr/local/include`
and the shared library in `/usr/local/lib`. This location can be controlled by
setting the `CMAKE_INSTALL_PREFIX` accordingly.

## Using SCL
# Using SCL

To use SCL, link `libscl.so` when building your program and include the
`include/` directory to your builds includes. The "examples" directory has some
simple examples that use scl, as well as a CMake file that can be used as
inspiration.

## Documentation
# Documentation

SCL uses Doxygen for documentation. Run `./scripts/build_documentation.sh` to
generate the documentation. This is placed in the `doc/` folder. Documentation
Expand Down