Skip to content

Commit 8aa6df2

Browse files
committed
update readme
1 parent 693e837 commit 8aa6df2

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,17 @@ field, getting networking to work, or instantiating a PRG or hash function.
1111
Hopefully, by using SCL, researches (and hobbyists) will find it a lot easier,
1212
and quicker!, to implement MPC protocols.
1313

14-
## Building SCL
14+
### Disclaimer
15+
16+
SCL is distributed under the GNU Affero General Public License, for details,
17+
refer to `LICENSE` or [https://www.gnu.org/licenses/](https://www.gnu.org/licenses/).
18+
19+
This program is distributed in the hope that it will be useful, but WITHOUT ANY
20+
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
21+
PARTICULAR PURPOSE.
22+
23+
24+
# Building SCL
1525

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

40-
## Using SCL
50+
# Using SCL
4151

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

47-
## Documentation
57+
# Documentation
4858

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

0 commit comments

Comments
 (0)