commit 3d4b48f9a516f570cf9dd78164ace7e771c6fe5b Author: Vincent Forest <vincent.forest@meso-star.com> Date: Thu, 8 Sep 2022 15:50:01 +0200 Write the README file Diffstat:
| A | README.md | | | 35 | +++++++++++++++++++++++++++++++++++ |
1 file changed, 35 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -0,0 +1,35 @@ +# Rad-Net File List + +This C library loads a set of file names listed according to the rnml file format + +## How to build + +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. + +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. + +## Copyright notice + +Copyright (C) 2022 Centre National de la Recherche Scientifique +Copyright (C) 2022 Institut de Physique du Globe de Paris +Copyright (C) 2022 [|Méso|Star>](https://www.meso-star.com) (<contact@meso-star.com>) +Copyright (C) 2022 Université de Reims Champagne-Ardenne +Copyright (C) 2022 Université de Versaille Saint-Quentin +Copyright (C) 2022 Université Paul Sabatier (<contact@laplace.univ-tlse.fr>) + +## License + +Rad-Net File 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.