Skip to content

Commit

Permalink
Update link to TribitsUsersGuide.html and change to *.md file (TriBIT…
Browse files Browse the repository at this point in the history
  • Loading branch information
bartlettroscoe committed Jun 26, 2021
1 parent 0a06166 commit 6941333
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
#
# TribitsExampleProject Documentation
#

The project TribitsExampleProject defines a TriBITS CMake project designed to
provide a simple example to demonstrate how to use the TriBITS system to
Expand All @@ -9,14 +7,17 @@ architecture.

To get started building you can create a directory structure like:

```
~/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 \
Expand All @@ -25,14 +26,17 @@ After that configure pointing to some value TriBITS source dir <tribits-dir>
-DTribitsExProj_ENABLE_ALL_PACKAGES=ON
-DCMAKE_CXX_COMPILER=g++ \
../../examples/TribitsExampleProject
```

and then build and test with:

```
make -j4 && ctest -j4
```

The layout of a TriBITS project is described in:

https://tribits.org/doc/TribitsDevelopersGuide.html#tribits-project-structure
* https://tribits.org/doc/TribitsUsersGuide.html#tribits-project-structure

Otherwise, this example TriBITS project is simple enough that it should be
enough to get started as a template.
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
macro(TRIBITS_PROJECT_DEFINE_PACKAGING)

tribits_copy_installer_resource(TribitsExProj_README
"${TribitsExProj_SOURCE_DIR}/README"
"${TribitsExProj_BINARY_DIR}/README.txt")
"${TribitsExProj_SOURCE_DIR}/README.md"
"${TribitsExProj_BINARY_DIR}/README.md")
tribits_copy_installer_resource(TribitsExProj_LICENSE
"${TribitsExProj_SOURCE_DIR}/LICENSE"
"${TribitsExProj_BINARY_DIR}/LICENSE.txt")
Expand Down

0 comments on commit 6941333

Please sign in to comment.