Skip to content

Commit

Permalink
Tweak documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Cliff Foster committed Mar 1, 2024
1 parent 1e53da8 commit bb07a5f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions lib/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ idi_add_third_party_dependency(
)
```

Both functions are identical in signature, but with slight differences in that `idi_add_third_party_dependency()` will place dependencies in `lib/.third-party` instead of directly in `lib/` and `idi_add_first_party_dependency()` will _not_ replace files if the configuration is wiped out, but warn instead about untracked/modified files and mismatching git checkout information.
Both functions are identical in signature, but with slight differences in that `idi_add_third_party_dependency()` will place dependencies in `lib/third-party` instead of directly in `lib/first-party` and `idi_add_first_party_dependency()` will _not_ replace files if the configuration is wiped out, but warn instead about untracked/modified files and mismatching git checkout information.

The value of `<name>` should be the same as the underlying CMake `project()` name to make sure that if multiple dependencies use it, it has a higher chance of matching and preventing duplicate dependencies.

Expand All @@ -37,7 +37,7 @@ The value of `<name>` should be the same as the underlying CMake `project()` nam

### CMake Variables

`IDICMAKE_EXTERNAL_LIB_DIR` points to the root library folder
`IDICMAKE_EXTERNAL_LIB_DIR` points to the first-party library folder

`IDICMAKE_EXTERNAL_THIRD_PARTY_LIB_DIR` points to the third party library directory.

Expand Down

0 comments on commit bb07a5f

Please sign in to comment.