Skip to content
Snippets Groups Projects
Commit ff5f2177 authored by Dilawar Singh's avatar Dilawar Singh
Browse files

readme with WITH_DOC option explained.

parent f60abf55
No related branches found
No related tags found
No related merge requests found
...@@ -10,10 +10,15 @@ set(DATA_DIR ${CMAKE_SOURCE_DIR}/data) ...@@ -10,10 +10,15 @@ set(DATA_DIR ${CMAKE_SOURCE_DIR}/data)
set(OUTPUT_MOOSEBIN ${MOOSE_CORE_BUILD_DIR}/moose.bin) set(OUTPUT_MOOSEBIN ${MOOSE_CORE_BUILD_DIR}/moose.bin)
set(OUTPUT_MOOSESDIST ${MOOSE_CORE_BUILD_DIR}/moose-${MOOSE_VERSION}.tar.gz) set(OUTPUT_MOOSESDIST ${MOOSE_CORE_BUILD_DIR}/moose-${MOOSE_VERSION}.tar.gz)
# Options to pass down to moose-core
option(WITH_DOC "Build documentation" OFF)
option(DEBUG "Build with DEBUG support" OFF)
add_custom_command(OUTPUT ${OUTPUT_MOOSEBIN} ${OUTPUT_MOOSESDIST} add_custom_command(OUTPUT ${OUTPUT_MOOSEBIN} ${OUTPUT_MOOSESDIST}
COMMAND ${CMAKE_COMMAND} COMMAND ${CMAKE_COMMAND}
-DCMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX} -DCMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX}
-DDEBUG=OFF -DDEBUG=${DEBUG}
-DWITH_DOC=${WITH_DOC}
${MOOSE_CORE_DIR} ${MOOSE_CORE_DIR}
COMMAND $(MAKE) COMMAND $(MAKE)
WORKING_DIRECTORY ${MOOSE_CORE_BUILD_DIR} WORKING_DIRECTORY ${MOOSE_CORE_BUILD_DIR}
......
...@@ -15,6 +15,21 @@ moose from this repository. ...@@ -15,6 +15,21 @@ moose from this repository.
make make
sudo make install sudo make install
## Fine tuning build process
You can pass options to cmake from command line to fine-tune the build process.
For example, by default, we don't build documentation. If you want to build
documentation,
$ cmake -DWITH_DOC=ON ..
$ make
Doing so, cmake will also build documentation (and later install it when `make
install` is used). Building documentation requires `python-sphinx` and
`doxygen`. __TODO: Document cmake options__.
# Uninstalling
To uninstall moose, run the following command in the same directory where you ran To uninstall moose, run the following command in the same directory where you ran
previous `make install` command. previous `make install` command.
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment