From c758a07891cac6a61319d6011becc1de0f2ee8f4 Mon Sep 17 00:00:00 2001
From: Ivan Pelipenko <peri4ko@yandex.ru>
Date: Sat, 25 Apr 2020 20:05:06 +0300
Subject: [PATCH] readme

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..080294de
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# Platform-Independent Primitives library
+## Introduction
+Low-level C++ library that covers next areas:
+* Strings
+* Console IO
+* Threads
+* Timers
+* Events
+* Various IO devices
+* Mathematics (FFT with libfftw3)
+* Cryptography (libsodium)
+* Compression (zlib)
+* Resources
+* Metaprogramming
+## CMake
+This library tightly integrated with CMake by providing some macro:
+*  pip_code_model(<out_var> file0 [file1 ...] [OPTIONS opt0 [opt1 ...] ] [ABSOLUTE])
+Generate code model files for source files file0 [file1 ...]
+
+Options you can see by exec "pip_cmg -h"
+If not ABSOLUTE source files will be prepended by CMAKE_CURRENT_SOURCE_DIR
+You should add ${<out_var>} to your target
+
+* pip_resources(<out_var> file)
+
+Generate C++ files for resource file
+You should add ${<out_var>} to your target