commit 89dfc4131442c9ce403cb02930d5f516c5be8eae
parent 2ddf597b2f74e6c09e13de4febac3fea4522148c
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Fri, 30 Jun 2023 17:08:56 +0200
Rewrite the README file
Rewrite of the preview. Add a requirements section that lists project
dependencies. And complete rewrite of the installation procedure
concerning the use of a POSIX Makefile and no longer CMake as the first
build system.
Diffstat:
| M | README.md | | | 37 | ++++++++++++++++++------------------- |
1 file changed, 18 insertions(+), 19 deletions(-)
diff --git a/README.md b/README.md
@@ -1,23 +1,21 @@
# RSIMD
-This C89 library defines an interface that encapsulates and make easier the
-manipulation of SIMD instruction sets. It also provides a SIMD implementation
-of linear algebra operations for 3x3 and 4x4 matrices as well as quaternions
-arranged in an `Array of Structures` SIMD layout. Linear algebra functions on
-`Structure of Arrays` 2/3/4 dimensions vectors are also implemented. Finally it
-exposes a vectorized version of some math functions by relying on the
-[Sleef](https://sleef.org/) library.
+RSIMD is a C library whose purpose is to facilitate the use of SIMD instruction
+sets. It implements linear algebra operations for 3x3 and 4x4 matrices stored
+in SIMD vectors as arrays of structures. Vectorized linear algebra operations
+on structures of arrays, for 2, 3 and 4 dimensional vectors are also
+implemented. Finally, it provides a vectorized version of the standard
+mathematical functions.
+
+## Requirements
+
+A C99 compiler, POSIX make, and the RSys and Sleef header files and libraries.
## How to build
-The library uses [CMake](http://www.cmake.org) and the
-[RCMake](https://gitlab.com/vaplv/rcmake/) package to build. It also depends on
-the [RSys](https://gitlab.com/vaplv/rsys/) and the [Sleef](https://sleef.org)
-library. First, install the RCMake package, the RSys and the Sleef libraries.
-Then, generate the project from the cmake/CMakeLists.txt file by appending the
-RCMake, RSys and Sleef install directories to the `CMAKE_PREFIX_PATH` variable.
-The resulting project can be edited, built, tested and installed as any CMake
-project.
+Edit config.mk as needed, then run:
+
+ make clean install
## Release notes
@@ -39,7 +37,8 @@ project.
## License
-Copyright (C) 2014-2019, 2021, 2023 Vincent Forest (vaplv@free.fr). RSIMD 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 file for details.
+Copyright (C) 2014-2019, 2021, 2023 Vincent Forest (vaplv@free.fr)
+
+RSIMD 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 file for details.
