diff --git a/tribits/examples/TribitsExampleApp/README.md b/tribits/examples/TribitsExampleApp/README.md index 9d9b99bb0..8711450ac 100644 --- a/tribits/examples/TribitsExampleApp/README.md +++ b/tribits/examples/TribitsExampleApp/README.md @@ -1,8 +1,10 @@ # TribitsExampleApp The example project `TribitsExampleApp` is a raw CMake project that pulls in -libraries from packages from `TribitsExampleProject`. To build against all of -the installed packages from an upstream `TribitsExampleProject`, configure, +libraries from packages from `TribitsExampleProject`. If `WithSubpackageC` +subpackage or the `MixedLang` packages are built, then a Fortran compiler +is required to build `TribitsExampleApp`. To build against all of the +installed packages from an upstream `TribitsExampleProject`, configure, build, and run the tests with: ``` diff --git a/tribits/examples/TribitsExampleProject/README.md b/tribits/examples/TribitsExampleProject/README.md index 217cd7343..ab0b5b42b 100644 --- a/tribits/examples/TribitsExampleProject/README.md +++ b/tribits/examples/TribitsExampleProject/README.md @@ -3,7 +3,8 @@ The project `TribitsExampleProject` defines a TriBITS CMake project designed to provide a simple example to demonstrate how to use the TriBITS system to create a CMake build, test, and deployment system using a package-based -architecture. +architecture. To build all of the packages from `TribitsExampleProject`, +a Fortran compiler is needed. To build and test the project, one must first create a build directory and configure by pointing to the TriBITS source dir `` @@ -17,18 +18,31 @@ with: cmake \ -DTribitsExProj_TRIBITS_DIR= \ + -DCMAKE_INSTALL_PREFIX= -DTribitsExProj_ENABLE_TESTS=ON \ -DTribitsExProj_ENABLE_ALL_PACKAGES=ON + -DTribitsExProj_ENABLE_SECONDARY_TESTED_CODE=ON \ -DCMAKE_CXX_COMPILER=g++ \ ``` -and then build and test with: +then build and test with: ``` make -j4 && ctest -j4 ``` +and then install: + +``` + make install +``` + +`TribitsExampleProject` will be installed to +`` and this path should be then used +to point `-DCMAKE_PREFIX_PATH=` when +building e.g. `TribitsExampleApp` + The layout of a TriBITS project is described in: * https://tribits.org/doc/TribitsUsersGuide.html#tribits-project-structure