Updated README

This commit is contained in:
Andrei Medar 2020-09-23 17:21:15 +00:00
parent 9bc3d123a9
commit 11a7125341

View File

@ -10,16 +10,21 @@ Even if many of the functions from the library can be sandboxed, there are some
## Patches ## Patches
In the **patches** folder there is a patch file that adds **extern "C"** to the required functions in the header file in order to sandbox them. This patch is applied automatically during the build phase. In the **patches** folder there is a patch file that adds `extern "C"` to the required functions in the header file in order to sandbox them. This patch is applied automatically during the build phase.
## Build ## Build
First, run `git submodule update --init --recursive` to update submodules. First, run `git submodule update --init --recursive` to update submodules.
After this, run the following commands: After this, run the following commands:
`mkdir -p build && cd build` `mkdir -p build && cd build`
`cmake .. -G Ninja` `cmake .. -G Ninja`
`ninja`
The example binary files can be found in `build/examples` `cmake --build .`
The example binary files can be found in `build/examples`.
## Examples ## Examples