README.md

AMCL

This directory contains the source code for the AMCL Library.

The directory structure is as follows

./c

- C Source code

./js

- JavaScript code

./java

- JAVA code

./java64

- JAVA code optimal for a 64-bit Virtual Machine

./go

- GO code

./swift

- swift code

./cs

- C# code

./pythonCFFI

- Python code that accesses the C library via the CFFI module

./testVectors

- Test Vectors

./docs

- Documentation

Build Instructions

AMCL is a standards compliant C library with no external dependencies. It can be built using the CMake build system. In order to use the Python wrappers CFFI is also required. There are instructions provided for both Linux and Windows based systems.

Instructions for the Linux build are in ./linux.md

Instructions for the Mac OS build are in ./mac.md

Instructions for the Windows build are in ./windows.md