commit 8b617f44dcdbab40a693396a2c64025c728ec7dd
parent 7e6edfccd4ea9f06248eeb8d175f1403bdce35c4
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Fri, 15 Sep 2023 16:39:46 +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 | | | 55 | ++++++++++++++++++++++++------------------------------- |
1 file changed, 24 insertions(+), 31 deletions(-)
diff --git a/README.md b/README.md
@@ -1,40 +1,33 @@
# 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),
-[RNSL](htpps://gitlab.com/meso-star/rnsl),
-[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
-[Star-ScatteringFunctions](https://gitlab.com/meso-star/star-sf)
-libraries. It optionally depends on [scdoc](https://sr.ht/~sircmpwn/scdoc/)
-which, if available, is used to generate the man pages.
-
-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
+This C library loads and manages the geometric data and physical properties of
+of a telluric planet's ground.
+
+## Requirements
+
+- C compiler
+- POSIX make
+- pkg-config
+- [ModRadUrb: MaTeriaL](https://gitlab.com/meso-star/mrumtl)
+- [Rad-Net String List](https://gitlab.com/meso-star/rnsl)
+- [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)
+- [Star Scattering Functions](https://gitlab.com/meso-star/star-sf)
+
+## Installation
+
+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
