From f02248d478eee98ded8ca5f1a3ae1722d08ad6e4 Mon Sep 17 00:00:00 2001
From: Kris Kwiatkowski <contact@amongbytes.com>
Date: Wed, 24 Mar 2021 23:34:34 +0000
Subject: [PATCH] pqapi.h -> pqc.h

---
 CMakeLists.txt                       |  2 +-
 README.md                            | 14 ++++++++++++++
 src/capi/pqapi.h => public/pqc/pqc.h |  0
 src/capi/pqapi.c                     |  2 +-
 test/ut.cpp                          |  2 +-
 5 files changed, 17 insertions(+), 3 deletions(-)
 rename src/capi/pqapi.h => public/pqc/pqc.h (100%)

diff --git a/CMakeLists.txt b/CMakeLists.txt
index cbeee123..a405285f 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -77,7 +77,7 @@ else()
 endif()
 
 include_directories(
-  inc
+  public
   src/common/
   src
 )
diff --git a/README.md b/README.md
index 6de56f45..accb3b87 100644
--- a/README.md
+++ b/README.md
@@ -23,3 +23,17 @@ This is a repository of post-quantum schemes coppied from the submission to the
 
 **Alternate candidates:**
 * SPHINCS+
+
+## Building
+
+CMake is used to build the library:
+
+```
+mkdir build
+cd build
+cmake -DCMAKE_BUILD_TYPE=Release ..
+make
+```
+
+Build outputs two libraries, a static ``libpqc_s.a`` and dynamic ``libpqc.so``, which can be linked with a project.
+
diff --git a/src/capi/pqapi.h b/public/pqc/pqc.h
similarity index 100%
rename from src/capi/pqapi.h
rename to public/pqc/pqc.h
diff --git a/src/capi/pqapi.c b/src/capi/pqapi.c
index 664af7d1..6a72ccad 100644
--- a/src/capi/pqapi.c
+++ b/src/capi/pqapi.c
@@ -1,6 +1,6 @@
 #include <stdint.h>
 #include <stdbool.h>
-#include "pqapi.h"
+#include <pqc/pqc.h>
 
 // PQClean include
 #include "sign/rainbow/rainbowV-classic/clean/api.h"
diff --git a/test/ut.cpp b/test/ut.cpp
index da0f6109..736f48ba 100644
--- a/test/ut.cpp
+++ b/test/ut.cpp
@@ -1,7 +1,7 @@
 #include <algorithm>
 #include <vector>
 #include <gtest/gtest.h>
-#include "capi/pqapi.h"
+#include <pqc/pqc.h>
 
 TEST(Kyber,KEMOneOff) {