commit 877b9676c10f86f4d4c2e37a5b8d001d68e3f336
parent 139e98f68b1740d17138c3e21a226840f1dc7c89
Author: vaplv <vaplv@free.fr>
Date: Tue, 27 Jun 2023 11:48:59 +0200
Rewritten README file
Cleanup and small rewrite of the overview. Complete rewrite of the
installation procedure with regard to the use of a POSIX Makefile and no
longer CMake
Diffstat:
| M | README.md | | | 31 | +++++++++++++++---------------- |
1 file changed, 15 insertions(+), 16 deletions(-)
diff --git a/README.md b/README.md
@@ -1,19 +1,18 @@
# RSys
-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 functionalities (thread,
-timer, ref counter, etc.), generic containers (dynamic array, hash table, etc.)
-and basic mathematics (linear algebra, quaternions, etc.)
+RSys is a library written in C89 defining several basic components useful for
+developing C programs but not implemented in the standard C library. Among
+other things, it provides macros describing the host environment (OS, compiler,
+processor architecture, etc.), low-level abstractions (thread, timer, ref
+counter, etc.), generic containers (dynamic arrays, table of hashes, linked
+lists etc.) or even basic linear algebra to manipulate vectors and matrices of
+dimensions 2, 3 or 4.
-## How to build
+## Installation
-The RSys library uses [CMake](http://www.cmake.org) and the
-[RCMake](https://gitlab.com/vaplv/rcmake/#tag-readme) package to build. First,
-install the RCMake package in a given `<RCMAKE_DIR>` directory. Then, generate
-the CMake project from the `cmake/CMakeLists.txt` file by appending the
-`<RCMAKE_DIR>` directory to the `CMAKE_PREFIX_PATH` variable. The resulting
-project can be now edited, built, tested and installed as any CMake project.
+Edit config.mk as needed, then run:
+
+ make clean install
## Release notes
@@ -165,8 +164,8 @@ project can be now edited, built, tested and installed as any CMake project.
## License
-Copyright (C) 2013-2023 Vincent Forest (vaplv@free.fr). RSys is free software
-released under the GPL v3+ license: GNU GPL version 3 or later. You are welcome
-to redistribute it under certain conditions; refer to the COPYING files for
-details.
+Copyright © 2013-2023 Vincent Forest (vaplv@free.fr)
+RSys is free software released under the GPL v3+ license: GNU GPL version 3 or
+later. You are welcome to redistribute it under certain conditions; refer to
+the COPYING files for details.
