commit f9096b25a9bb7a4ccc71f98d32e692da12b1fa2b
parent 4b5750d5a7e4c978523bba6aecb322fe93c27112
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Mon, 9 Mar 2015 16:45:11 +0100
Update the README file
Diffstat:
| M | README.md | | | 30 | +++++++++++++++++++++++------- |
1 file changed, 23 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
@@ -1,12 +1,28 @@
# Star 3D
-This library allows to declare a virtual 3D environment that can be ray-traced
-and sampled efficiently. Currently, the virtual scene can contain triangular
-meshes only.
+The purpose of the library is to declare a virtual 3D environment that can be
+ray-traced and sampled efficiently. Currently, the virtual scene can contain
+triangular meshes only.
-# License
+## How to build
-This library is a free software released under the CeCILL license. You are
-welcome to redistribute it under certain conditions; refer to the COPYING files
-for details.
+The *Star-3D* library uses [CMake](http://www.cmake.org) and the
+[RCMake](https://gitorious.org/code-plot/rcmake/) package to build. It also
+depends on the [RSys](https://gitorious.org/code-plot/rsys/) library.
+
+First ensure that CMake is installed on your system. Then install the RCMake
+package and the RSys library. Finally generate the project from the
+`cmake/CMakeLists.txt` file by appending to the `CMAKE_PREFIX_PATH` variable
+the `<RCMAKE_INSTALL_DIR>/lib/cmake` and `<RSYS_INSTALL_DIR>` directories,
+where `<RCMAKE_INSTALL_DIR>` and `<RSYS_INSTALL_DIR>` are the install
+directories of the RCMake package and the RSys library, respectively. The
+generated project can be edited, built, tested and installed as any CMake
+project.
+
+## License
+
+The *Star-3D* library is a free software released under the
+[OSI](http://opensource.org)-approved CeCILL license. You are welcome to
+redistribute it under certain conditions; refer to the COPYING files for
+details.
