Add information about the project
This commit is contained in:
48
README.md
Normal file
48
README.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# libsodium-cmake
|
||||
|
||||
## Description
|
||||
|
||||
CMakeWrapper for [libsodium](https://github.com/jedisct1/libsodium), the modern, portable, easy to use crypto library.
|
||||
|
||||
This wrapper is written with a few goals in mind:
|
||||
1. It should be easy to build
|
||||
1. It should be obvious that libsodium's source code hasn't been touched
|
||||
1. It should be easy to integrate into projects
|
||||
|
||||
## Building
|
||||
|
||||
Clone!
|
||||
|
||||
`git clone --recursive https://github.com/robinlinden/libsodium-cmake.git`
|
||||
|
||||
Build!
|
||||
|
||||
```sh
|
||||
mkdir build && cd build
|
||||
cmake ..
|
||||
make
|
||||
make test
|
||||
```
|
||||
|
||||
## Using in your project
|
||||
|
||||
```cmake
|
||||
FetchContent_Declare(
|
||||
Sodium
|
||||
GIT_REPOSITORY https://github.com/robinlinden/libsodium-cmake.git
|
||||
)
|
||||
|
||||
FetchContent_GetProperties(Sodium)
|
||||
if(NOT sodium_POPULATED)
|
||||
FetchContent_Populate(Sodium)
|
||||
add_subdirectory(
|
||||
${sodium_SOURCE_DIR}
|
||||
${sodium_BINARY_DIR}
|
||||
)
|
||||
endif()
|
||||
|
||||
target_link_libraries(${PROJECT_NAME}
|
||||
PRIVATE
|
||||
sodium
|
||||
)
|
||||
```
|
||||
Reference in New Issue
Block a user