Skip to content

Commit

Permalink
Merge pull request #441 from marcinwrobel1986/fix-TribitsExampleProje…
Browse files Browse the repository at this point in the history
…ct-doc

TribitsExampleProject readme fix
  • Loading branch information
bartlettroscoe authored Jan 28, 2022
2 parents 8a733c2 + 92274d3 commit d374a38
Showing 1 changed file with 11 additions and 16 deletions.
27 changes: 11 additions & 16 deletions tribits/examples/TribitsExampleProject/README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,26 @@
# TribitsExampleProject Documentation

The project TribitsExampleProject defines a TriBITS CMake project designed to
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.

To get started building you can create a directory structure like:
To build and test the project, one must first create a build directory and
configure by pointing to the TriBITS source dir `<tribits-dir>`
(i.e. `TriBITS/tribits`) and the `TribitsExampleProject` project source dir
with:

```
~/TribitsExampleProject.base/
TribitsExampleProject/ # This directory
BUILDS/
SERIAL/
```

After that configure pointing to some value TriBITS source dir <tribits-dir>
(i.e. TriBITS/tribits) with:

```
cd BUILDS/SERIAL/
cmake -D \
mkdir <build-dir>
cd <build-dir>
cmake \
-DTribitsExProj_TRIBITS_DIR=<tribits-dir> \
-DTribitsExProj_ENABLE_TESTS=ON \
-DTribitsExProj_ENABLE_ALL_PACKAGES=ON
-DCMAKE_CXX_COMPILER=g++ \
../../examples/TribitsExampleProject
<path-to-TribitsExampleProject>
```

and then build and test with:
Expand Down

0 comments on commit d374a38

Please sign in to comment.