commit faa41c6c93190368cdb82ed064ed99c4140bfec0
parent 43c7ca99a61885a7c57f593d5054c15e017a61b4
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Fri, 15 Sep 2023 10:43:23 +0200
Rewrite the README file
Rework the overview section. Addition of a section on project
requirements and dependencies. Complete rewrite of the installation
procedure concerning the use of POSIX make instead of CMake as the first
build system.
Diffstat:
| M | README.md | | | 36 | +++++++++++++++++------------------- |
1 file changed, 17 insertions(+), 19 deletions(-)
diff --git a/README.md b/README.md
@@ -1,30 +1,28 @@
# Rad-Net String List
-This C library loads a set of file names listed according to the rnsl file format
+This C library loads a set of strings listed according to the rnsl file format.
+See `rnsl.5` for format specification.
-## How to build
+## Requirements
-This library is compatible with 64-bits POSIX systems. It relies the
-[CMake](http://www.cmake.org) and the
-[RCMake](https://gitlab.com/vaplv/rcmake/) packages to build. It also depends
-on the [RSys](https://gitlab.com/vaplv/rsys/) library. It optionally depends on
-[scdoc](https://sr.ht/~sircmpwn/scdoc/) which, if available, is used to
-generate the man page of the Star-CK file format.
+- C compiler
+- POSIX make
+- pkg-config
+- [RSys](https://gitlab.com/vaplv/rsys)
+- [mandoc](https://mandoc.bsd.lv)
-First ensure that CMake is installed on your system. Then install the RCMake
-package as well as the aforementioned prerequisites. Finally generate the
-project from the `cmake/CMakeLists.txt` file by appending to the
-`CMAKE_PREFIX_PATH` variable the install directories of its dependencies. The
-resulting project can be edited, built, tested and installed as any CMake
-project. Refer to the [CMake documentation](https://cmake.org/documentation)
-for further informations on CMake.
+## Installation
-## Copyright notice
+Edit config.mk as needed, then run:
+
+ make clean install
+
+## Copyrights
Copyright (C) 2022, 2023 Centre National de la Recherche Scientifique
Copyright (C) 2022, 2023 Institut Pierre-Simon Laplace
Copyright (C) 2022, 2023 Institut de Physique du Globe de Paris
-Copyright (C) 2022, 2023 [|Méso|Star>](https://www.meso-star.com) (<contact@meso-star.com>)
+Copyright (C) 2022, 2023 [|Méso|Star>](https://www.meso-star.com) (contact@meso-star.com)
Copyright (C) 2022, 2023 Observatoire de Paris
Copyright (C) 2022, 2023 Université de Reims Champagne-Ardenne
Copyright (C) 2022, 2023 Université de Versaille Saint-Quentin
@@ -32,6 +30,6 @@ Copyright (C) 2022, 2023 Université Paul Sabatier
## License
-Rad-Net String List is free software released under the GPL v3+ license: GNU GPL
-version 3 or later. You are welcome to redistribute it under certain
+Rad-Net String List 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.
