commit 0813e79bb8f125e9ba12cb110da00f666994eb3c
parent 1a9900a65feb4180ea7215af300bad53011f358f
Author: vaplv <vaplv@free.fr>
Date: Fri, 19 Sep 2014 17:00:17 +0200
Add README documentations
Diffstat:
1 file changed, 18 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
@@ -1,4 +1,19 @@
-rsys
-====
+# RSys
-Minimalist library defining platform specific macros and data structures.
+Minimalist C89 library defining several basic components helpful in the
+development of multi-platform C libraries/applications. It provides macros that
+describe the host environment (OS, compiler, etc.), several platform agnostic
+functionalities (thread, timer, etc.), generic containers (dynamic array, hash
+table, etc.) and basic mathematics (linear algebra, etc.)
+
+Currently, only the `GCC + GNU/Linux` and `MinGW + Microsoft Windows` x86\_[64]
+platforms are officially supported.
+
+## How to build
+
+The library uses [CMake](http://www.cmake.org) and the RCMake package to build.
+First, install the RCMake package in a given `<RCMAKE_DIR>` directory. Then,
+generate the RSys CMake project from the `cmake/CMakeLists.txt` file by
+appending the `<RCMAKE_DIR>/lib/cmake` directory to the `CMAKE_PREFIX_PATH`
+variable. The resulting project can be now edited, built, tested and installed
+as any CMake project.
