commit 1d07d4a887d6d6be13440042595f96ed9c0a2f37
parent 644b1e4743bd80c18526ce71be2a2198a9a30b08
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Tue, 18 Jul 2023 16:34:59 +0200
Rewrite the README file
Cleanup and small rewrite of the preview. Add a requirements section
that lists the dependencies of the project. Complete rewrite of the
installation procedure regarding the use of a POSIX Makefile and no
longer CMake.
Diffstat:
| M | README.md | | | 55 | ++++++++++++++++++++++++++----------------------------- |
1 file changed, 26 insertions(+), 29 deletions(-)
diff --git a/README.md b/README.md
@@ -1,28 +1,25 @@
-# Star-ScatteringFunctions
-
-This library provides a set of abstractions to describe the way the light is
-scattered with respect to a geometric optics model. It defines interfaces to
-describe Bidirectional Scattering Distribution Functions, microfacet
-distributions, Fresnel terms and phase functions. Several built-in
-implementation of these interfaces are provided as specular, lambertian and
-microfacet reflections, Beckmann and Blinn microfacet distributions,
-dielectric/dielectric and dielectric/conductor Fresnel terms, Henyey &
-Greenstein and Rayleigh phase functions, etc.
-
-## How to build
-
-The library uses [CMake](http://www.cmake.org) and the
-[RCMake](https://gitlab.com/vaplv/rcmake/#tab-readme) package to build. It also
-depends on the [Star-SP](https://gitlab.com/meso-star/star-sp/#tab-readme) and
-the [RSys](https://gitlab.com/vaplv/rsys/#tab-readme) libraries. The
-[RSIMD](https://gitlab.com/vaplv/rsimd) library is an optional dependency
-which, if installed, is used to speed up the configuration of the RDG-FA phase
-function.
-
-First ensure that CMake is installed on your system. Then install the RCMake
-package as well as all 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.
+# Star Scattering Functions
+
+This library provides a set of data structures to describe how light is
+scattered on the surface or in volume. From these interfaces, it implements
+several Bidirectional Scattering Distribution Functions, microfacet
+distributions, Fresnel terms or even phase functions. See the `ssf.h` header
+file for a full list of proposed implementations
+
+## Requirements
+
+- C compiler
+- POSIX make
+- pkg-config
+- [RSys](https://gitlab.com/vaplv/rsys)
+- [Star-SP](https://gitlab.com/meso-star/star-sp)
+- [RSIMD](https://gitlab.com/vaplv/rsimd) (optional)
+
+## Installation
+
+Edit config.mk as needed, then run
+
+ make clean install
## Release notes
@@ -84,8 +81,8 @@ Add a built-in phase function using the
## License
-Copyright (C) 2016-2018, 2021-2023 |Méso|Star> (<contact@meso-star.com>).
-Star-ScatteringFunctions is free software released under the GPL v3+ license.
-You are welcome to redistribute it under certain conditions; refer to the
-COPYING file for details.
+Copyright (C) 2016-2018, 2021-2023 |Méso|Star> (contact@meso-star.com)
+Star-SF is free software released under the GPL v3+ license. You are welcome
+to redistribute it under certain conditions; refer to the COPYING file for
+details.
