commit 9cfe3b349c7f371f8452f07892b8174665fb3a71
parent fa1fcbe737d0de3e2498e6c3dcf6bce516ff2b0a
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Fri, 15 May 2026 12:37:14 +0200
Rewrite the README file
Add a requirements section that lists project dependencies. Complete
rewrite of the installation procedure concerning the use of a POSIX
Makefile and no longer CMake as the first build system.
Wraps the README text in 72 columns to match the convention of plain
text e-mails. It can therefore be sent as a publication announcement
e-mail without being reformatted
Add a new line after each period that ends a sentence. This convention
follows that of man files written in mdoc, contributes to the clarity of
the source code, and simplifies the tracking of changes. Updating a
sentence may require reformatting it into 72 columns, which affects the
entire block of text in question. In this case, the change is now
limited to the single sentence rather than the entire paragraph.
Diffstat:
| M | README.md | | | 71 | +++++++++++++++++++++++++++++++++-------------------------------------- |
1 file changed, 33 insertions(+), 38 deletions(-)
diff --git a/README.md b/README.md
@@ -1,57 +1,53 @@
# Schiff
-The purpose of this program is to estimate the radiative properties of soft
-particles with an "Approximation Method for Short Wavelength or High-Energy
-Scattering" (L. Schiff, 1956). It relies on the model detailed in "Monte Carlo
-Implementation of Schiff's Approximation for Estimating Radiative Properties of
+The purpose of this program is to estimate the radiative properties of
+soft particles with an "Approximation Method for Short Wavelength or
+High-Energy Scattering" (L. Schiff, 1956).
+It relies on the model detailed in "Monte Carlo Implementation of
+Schiff's Approximation for Estimating Radiative Properties of
Homogeneous, Simple\-Shaped and Optically Soft Particles: Application to
Photosynthetic Micro-Organisms"
([Charon et al. 2015](http://www.sciencedirect.com/science/article/pii/S0022407315003283)).
-## How to build
+## Prerequisites
+- C compiler
+- POSIX make
+- pkg-config
+- [LibYAML](http://pyyaml.org/wiki/LibYAML),
+- [RSys](https://www.meso-star.com/git/rsys)
+- [Star-3D](https://www.meso-star.com/git/star-3d)
+- [Star-Schiff](https://www.meso-star.com/git/star-schiff)
+- [Star-SP](https://www.meso-star.com/git/star-sp)
-The library relies on the [CMake](http://www.cmake.org) and the
-[RCMake](https://gitlab.com/vaplv/rcmake/) package to build. It also depends
-on the
-[LibYAML](http://pyyaml.org/wiki/LibYAML),
-[RSys](https://gitlab.com/vaplv/rsys/),
-[Star-3D](https://gitlab.com/meso-star/star-3d/),
-[Star-Schiff](https://gitlab.com/meso-star/star-schiff/) and
-[Star-SP](https://gitlab.com/meso-star/star-sp/) libraries.
+## Installation
-First ensure that CMake is installed on your system. Then install the RCMake
-package as well as all the aforementioned prerequisites. Then generate the
-project from the `cmake/CMakeLists.txt` file by appending to the
-`CMAKE_PREFIX_PATH` variable the install directories of its dependencies.
+Edit config.mk as needed, then run:
-## How to use
-
-Refer to the
-[manual pages](https://gitlab.com/meso-star/schiff/tree/master/doc)
-for informations on the schiff program, the list of its options and the file
-formats on which it relies.
+ make clean install
## Release notes
### Version 0.4.2
-Sets the required version of Star-SampPling to 0.12. This version fixes
-compilation errors with gcc 11 but introduces API breaks.
+Sets the required version of Star-SampPling to 0.12.
+This version fixes compilation errors with gcc 11 but introduces API
+breaks.
### Version 0.4.1
-Displays the time spent constructing the geometric distribution, writing the
-sampled geometries, and performing the calculations.
+Displays the time spent constructing the geometric distribution, writing
+the sampled geometries, and performing the calculations.
### Version 0.4
-- Set the minimum number of scattering angles to 2 rather than the previous
- and arbitrary limit fixed to 100.
+- Set the minimum number of scattering angles to 2 rather than the
+ previous and arbitrary limit fixed to 100.
- Fix a bug in the generation of the shape of the helical pipe.
- Update the short help of the command as well as the man pages.
-- Add the `-D` option that discards all computations for large scattering
- angles.
-- Add the `--version` that prints the current version of the `schiff` command.
+- Add the `-D` option that discards all computations for large
+ scattering angles.
+- Add the `--version` that prints the current version of the `schiff`
+ command.
### Version 0.3.1
@@ -59,10 +55,9 @@ sampled geometries, and performing the calculations.
## License
-Copyright (C) 2020, 2021 [|Meso|Star>](http://www.meso-star.com)
-(<contact@meso-star.com>).
-Copyright (C) 2015, 2016 CNRS.
+Copyright (C) 2020, 2021 [|Meso|Star>](https://www.meso-star.com) (contact@meso-star.com)
+Copyright (C) 2015, 2016 CNRS
-Schiff 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.
+Schiff 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.
