commit 8c34e89ec1879221d1ba1aa66f38d549f6751290
parent e4ebf17030fc4f16c93101c3b097db47582e0d83
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Wed, 30 Mar 2016 15:12:02 +0200
Update the README file
Diffstat:
1 file changed, 13 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
@@ -2,8 +2,11 @@
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). Assume a small contrast on the relative
-refractive index of the particles.
+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
@@ -22,9 +25,16 @@ project from the `cmake/CMakeLists.txt` file by appending to the
`CMAKE_PREFIX_PATH` variable the install directories of its dependencies and
the one of the RCMake package.
+## 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.
+
## License
-Schiff is developped by [|Meso|Star>](http://www.meso-star.com) for the
+Schiff is developed by [|Meso|Star>](http://www.meso-star.com) for the
the [National Center for Scientific Research](http://www.cnrs.fr/index.php)
(CNRS). It is a free software copyright (C) CNRS 2015-2016 released under the
[OSI](http://opensource.org)-approved GPLv3+ license. You are welcome to
