commit fa43a576c1274e494121458f481408baf23baf40
parent 49f8bda2a3c5935c65c702f8bf8f27f0c0cbbda1
Author: vaplv <vaplv@free.fr>
Date: Thu, 18 Dec 2014 16:07:10 +0100
Small modifications of the README file
Diffstat:
1 file changed, 11 insertions(+), 13 deletions(-)
diff --git a/README.md b/README.md
@@ -1,19 +1,17 @@
# RSys
-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
+Tiny C89 library defining several basic components helpful in the development
+of C libraries/applications. Among others, it provides macros that describe the
+host environment (OS, compiler, etc.) several low level functionnalites
+(thread, timer, ref counter, 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.
+The RSys library uses [CMake](http://www.cmake.org) and the
+[RCMake](https://gitorious.org/code-plot/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.
