- add a basic documentation about using cmake and its GD options

1 files changed, 28 insertions, 0 deletions

diff --git a/docs/README.CMAKE b/docs/README.CMAKE
new file mode 100644
index 0000000..8ebf19d
--- /dev/null
+++ b/docs/README.CMAKE
@@ -0,0 +1,28 @@
+|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+
+Tobuild GD using CMake, all you need is (add the cmake options if you need any
+or if the default libs and include paths are not the default) :
+
+In a sub directory:
+$ mkdir bld
+$ cd bld
+$ cmake -DBUILD_TEST=1 <options>
+
+The available options are:
+ENABLE_PNG=1
+ENABLE_JPEG=1
+ENABLE_TIFF=1
+ENABLE_FREETYPE=1
+ENABLE_FONTCONFIG=1
+ENABLE_XPM=1
+
+You can optionnally run our tests suite using:
+$ ctest .
+
+Or if you like to build in the source tree:
+$ cmake -DBUILD_TEST=1 .
+$ ctest .
+
+Add "-DCMAKE_BUILD_TYPE=DEBUG" if you like to have a debug version.
+
+