From 895312750646f0d6f83f8ced1e597fc834937510 Mon Sep 17 00:00:00 2001 From: Philipp Edelmann Date: Wed, 19 Jun 2024 22:48:13 -0600 Subject: [PATCH] add some documentation on cmake build --- doc/source/User_Guide/getting_started.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/doc/source/User_Guide/getting_started.rst b/doc/source/User_Guide/getting_started.rst index d3f22bb3..041bf7a3 100644 --- a/doc/source/User_Guide/getting_started.rst +++ b/doc/source/User_Guide/getting_started.rst @@ -284,6 +284,21 @@ The **output** option is only respected when a particular **target** is specifie **make output=a.out install** will install all **rayleigh.*** executables, they will not be renamed. +.. _cmake: +Alternative: Configure using CMake +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +`CMake `_ can be used as an alternative to the configure script. It is especially useful when running on a new platform not yet supported by configure or when you are generally more comfortable with CMake from other projects. + +.. code-block:: bash + + # Create a build directory called "build" and configure Rayleigh in it. + cmake -Bbuild + # Optional: change settings (e.g., select a Debug or Release build) + cmake --build build -t edit_cache + # Build code in parallel and install in the bin directory + cmake --build -j -t install + .. _spack-setup: Alternative: Installation using Spack