Force the static linking

Readme typo fix

Author: qnfm

CMakeLists.txt

@@ -6,7 +6,7 @@ project(OceanKeyak C)
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 
 list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake)
-
+set(sodium_USE_STATIC_LIBS ON)
 find_package(Sodium REQUIRED)
 
 ################################################################################

README.md

@@ -2,11 +2,15 @@
 An cross-platform file encryption tool with AE scheme extracted from XKCP(eXtended Keccak Code Package)
 * [`Keyak`](https://github.com/XKCP/XKCP/blob/master/doc/Keyak-documentation.h), the authenticated encryption schemes River, Lake, Sea, Ocean and Lunar Keyak.This repo only extracts the OceanKeyak 
 
-# Dependencies
+## Dependencies
 
-## CMake
+### CMake
 
-Keyak requires CMake 3.10.0 or newer in order to take advantage of improved support. If you're using Ubuntu 18.04 or newer you should already have a suitable version. If you're using an older distribution (e.g. 16.04) you will need to install a compatible version of CMake yourself. Also, Keyak utilizes the libsodium api to generate unpredictable data, suitable for creating secret keys, so you should install [libsodium](https://download.libsodium.org/libsodium/releases/) into your system path if you are using linux distribution, or if you are using windows, you can type the following commad to set the sodium_DIR environment variable to point at the directory of pre-built libsodium from official website.
+Keyak requires CMake 3.10.0 or newer in order to take advantage of improved support. If you're using Ubuntu 18.04 or newer you should already have a suitable version. If you're using an older distribution (e.g. 16.04) you will need to install a compatible version of CMake yourself. 
+
+### libsodium
+
+Also, Keyak utilizes the libsodium api to generate unpredictable data, suitable for creating secret keys, so you should install [libsodium](https://download.libsodium.org/libsodium/releases/) into your system path if you are using linux distribution, or if you are using windows, you can type the following commad to set the sodium_DIR environment variable to point at the directory of pre-built libsodium from official website.
 
 ```cmd
 set sodium_DIR path_to_pre-built_lib
@@ -18,7 +22,7 @@ To install libsodium on Linux:
 sudo apt install libsodium-dev
 ```
 
-# Build
+## Build
 
 Clone the code and change into the source code directory
 
@@ -29,39 +33,33 @@ git clone https://github.com/qnfm/Standalone-OceanKeyak && cd Standalone-OceanKe
 If you have downloaded the ninja_build binary on Windows, the build command is:
 
 ```bash
-cmake "-DCMAKE_MAKE_PROGRAM=C:/path_to_ninja/ninja.exe" -G Ninja -S . -B cmake-build-debug -Dsodium_USE_STATIC_LIBS=ON
+cmake "-DCMAKE_MAKE_PROGRAM=C:/path_to_ninja/ninja.exe" -G Ninja -S . -B build
 ```
 
 Or run build without ninja:
 
 ```bash
-cmake -S . -B cmake-build-debug -Dsodium_USE_STATIC_LIBS=ON
+cmake -S . -B build
 ```
 
 Final step: link the program:
 
 ```bash
-cmake --build cmake-build-debug --target Keyak -j 8
+cmake --build build --target Keyak -j 8
 ```
 
-The binary is located in the cmake-build-debug/Release|Debug directory on Windows and cmake-build-debug/ directory on linux
+The binary is located in the build/ directory
 
-# Usage
+## Usage
 
-To encrypt, you simply need to provide thepath to the filename, remember to keep the generated two files safely and secretly. If you lose these two file (one with .key surfix and the other with .Keyak surfix), the original file will be lost forever !
+To encrypt, you simply need to provide the path to the filename, remember to keep the generated two files (one with `.key` surfix is the secret key and the other with `.Keyak` surfix is the encrypted file) safely and secretly. If you lose these two file , the original file will be lost forever!
 
-```
+```bash
 Keyak file_to_be_encrypted
 ```
 
 To decrypt, put the two output files at the same directory and simply call:
 
-```
+```bash
 Keyak path_to_key.key path_to_ciphertext.Keyak
 ```
-
-# Under which license is the XKCP distributed?
-
-Most of the source and header files in the XKCP are released to the **public domain** and associated to the [CC0](http://creativecommons.org/publicdomain/zero/1.0/) deed. The exceptions are the following:
-
-* [`brg_endian.h`](lib/common/brg_endian.h) is copyrighted by Brian Gladman and comes with a BSD 3-clause license;