commit 167385e72f2f6852703af7e460faf4923411c73d
parent 73ca96de75a8bd8dd4fbf8604709e41e46b57096
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Tue, 12 Jul 2022 14:50:00 +0200
Add a README file
Diffstat:
| A | README.md | | | 42 | ++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 42 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,42 @@
+# Rad-Net Ground
+
+This C library loads and manages data representing the ground of a telluric
+planet whose geometry is described by a
+[Start-Mesh](https://gitlab.com/meso-star/star-mesh) file and radiative
+properties loaded from [MruMtl](https://gitlab.com/meso-star/mrumtl) files.
+
+## 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
+[MruMtl](https://gitlab.com/meso-star/mrumtl),
+[RSys](https://gitlab.com/vaplv/rsys/),
+[Star-3D](https://gitlab.com/meso-star/star-3d),
+[Star-Buffer](https://gitlab.com/meso-star/star-buffer),
+[Star-Mesh](https://gitlab.com/meso-star/star-mesh), and
+libraries.
+
+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 Ground 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.
