Updated README.md

Author: forthommel

CMakeLists.txt

@@ -3,6 +3,9 @@ project(CepGenGrapeProcess)
 enable_language(Fortran)
 
 set(CEPGEN_PATH ${CEPGEN_PATH} $ENV{CEPGEN_PATH})
+if(NOT CEPGEN_PATH)
+  set(CEPGEN_PATH /usr/local)
+endif()
 if(NOT PROCESS_NAME)
   set(PROCESS_NAME FortranProcess)
 endif()
@@ -15,3 +18,8 @@ file(GLOB_RECURSE F77_SOURCES src/*.f)
 add_library(CepGen${PROCESS_NAME} SHARED ${SOURCES} ${F77_SOURCES})
 target_link_libraries(CepGen${PROCESS_NAME} PRIVATE ${CepGen_LIBRARIES})
 target_include_directories(CepGen${PROCESS_NAME} PRIVATE ${CepGen_INCLUDE_DIRS})
+
+file(GLOB_RECURSE input_cards RELATIVE ${PROJECT_SOURCE_DIR} cards/*)
+foreach(_files ${input_cards})
+  configure_file(${_files} ${_files} COPYONLY)
+endforeach()

README.md

@@ -1,32 +1,40 @@
 # Fortran process for CepGen
 This repository provides a simple skeletton of an implementation of a Fortran process in CepGen.
 
-Running `make` will build a shared library containing all requirements to define a process in CepGen's runtime environment.
+As for other CepGen-derived projects, the build system is [CMake](https://cmake.org/), and its "standard recipe".
 
-This `.so` or `.dll` library can then be imported through the `-a` argument of CepGen's main executable, or using the `cepgen::loadLibrary` statement in user-defined executables.
+If you are not using a precompiled version of CepGen (i.e. your version of CepGen is [built from sources](https://cepgen.hepforge.org/install)), the `CEPGEN_PATH` environment variable should be set to the base source directory:
 
-A working version of CepGen is obviously required on the building system.
-The default search paths for this installation are:
-* `/usr/local/lib64` for library objects (only the `CepGen` shared library is required), and
-* `/usr/local/include` for development headers.
+```bash
+export CEPGEN_PATH=/path/to/cepgen/sources
+```
 
-These two search paths can be overriden by setting the `$(CEPGEN_LIBS_DIR)` and `$(CEPGEN_INCLUDE_DIR)` environment variables prior to running `make`.
+Then, the usual CMake build recipe can be used:
 
-For instance, if a local source-build of CepGen is used, these two can take the value:
 ```bash
-export CEPGEN_LIBS_DIR=<path/to/cepgen/sources>/build
-export CEPGEN_INCLUDE_DIR=<path/to/cepgen/sources>
+mkdir build
+cd build
+cmake ..
+make [-j]
 ```
 
-In this example, the `dummy_process` Fortran double-precision typed function is built from the `*.f` source files (here, only [dummy_process.f](dummy_process.f), and registered using the [ProcessesWrapper.cpp](ProcessesWrapper.cpp) file.
+The resulting object is a shared library containing all requirements to define a process in CepGen's runtime environment.
+By default, the library name is set to `CepGenFortranProcess`.
+However you can override it using the `PROCESS_NAME` CMake variable, i.e. adding the flag `-DPROCESS_NAME=MyProcessName` in the `cmake` command.
+
+This `.so` or `.dll` library can then be imported through the `-a` argument of CepGen's main executable, or using the `cepgen::loadLibrary` statement in custom user-defined executables.
+
+In this example, the `dummy_process` Fortran double-precision typed function is built from the `*.f` source files (here, only [dummy_process.f](src/dummy_process.f), and registered using the [ProcessesWrapper.cpp](ProcessesWrapper.cpp) file.
 This latter acts as a link between the CepGen runtime environment and this new process definition.
 
 In this file, two functions are respectively declaring the main matrix element, and registering it into the runtime database:
-* `DECLARE_FORTRAN_FUNCTION( dummy_process )` takes the F77 name of the function as an argument ;
-* `REGISTER_FORTRAN_PROCESS( dummy, "A dummy Fortran process", dummy_process )` links this function to a new CepGen process named `dummy`, described with the second argument.
+* `DECLARE_FORTRAN_FUNCTION(dummy_process)` takes the F77 name of the function as an argument ;
+* `REGISTER_FORTRAN_PROCESS(dummy, "A dummy Fortran process", dummy_process)` links this function to a new CepGen process named `dummy`, described with the second argument.
 
 Once compiled and linked into a shared library, it can be loaded into the CepGen runtime environment and added into the processes collection.
 For the latter, the main CepGen executable can be steered when providing an extra `-a` flag linking to this library, i.e.
 ```bash
-$CEPGEN_PATH/bin/cepgen -a $PATH_TO/libCepGenUserProcess.so -i $PATH_TO/dummy_cfg.py
+$CEPGEN_PATH/bin/cepgen -a libCepGenFortranProcess.so -i cards/dummy_cfg.py
 ```
+
+All steering cards (conventionally, for backward compatibility, new ones should be following [the Python format](https://cepgen.hepforge.org/cards-python)) stored in the [cards/](cards) directory are copied into a new directory in the build directory, for simplicity.