From e99c10ba48523bb4e29be057b6239cb1f83288f6 Mon Sep 17 00:00:00 2001 From: Florent Pruvost <florent.pruvost@inria.fr> Date: Tue, 13 Dec 2016 13:53:03 +0100 Subject: [PATCH] Add first readme --- README.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++++ modules/find/css | 1 - 2 files changed, 61 insertions(+), 1 deletion(-) create mode 100644 README.md delete mode 120000 modules/find/css diff --git a/README.md b/README.md new file mode 100644 index 0000000..dd2909f --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +MORSE CMake modules +==================== + +This project provides a collection of CMake modules that can be shared +among projects using CMake as build system. + +For now it is mainly constituted of "Find" modules that help detecting +installed libraries on the system. These modules are located in + +Get morse_cmake +--------------------- + +To use latest development states of morse_cmake, please clone the +master branch: + + git clone git@gitlab.inria.fr:solverstack/morse_cmake.git + +Documentation +--------------------- + +TODO + +Installation +--------------------- + +To use MORSE modules you have to add the path to the modules in your +CMake project and include the MorseInit module: + + # Define where are located module files on your system + set(MORSE_CMAKE_MODULE_PATH "/where/is/morse_cmake" CACHE PATH "Path to morse_cmake sources") + # Append this directory to the list of directories containing CMake modules + list(APPEND CMAKE_MODULE_PATH "${MORSE_CMAKE_MODULE_PATH}/modules/" ) + # Include the init module + include(MorseInit) + # + +We recommend to use this project as a `git submodule` of your project. + +Get involved! +--------------------- + +### Mailing list + +TODO + +### Contributions + +https://gitlab.inria.fr/solverstack/morse_cmake/blob/master/CONTRIBUTING.md + +### Authors + +The following people contributed to the development of morse_modules: + * Cedric Castagnede + * Mathieu Faverge, PI + * Florent Pruvost, PI + +If we forgot your name, please let us know that we can fix that mistake. + +### Licence + +https://gitlab.inria.fr/solverstack/morse_cmake/blob/master/LICENCE.txt diff --git a/modules/find/css b/modules/find/css deleted file mode 120000 index a7287ed..0000000 --- a/modules/find/css +++ /dev/null @@ -1 +0,0 @@ -../../../../../doc/css \ No newline at end of file -- GitLab