Skip to content

Commit fd989d9

Browse files
committed
Note requirements.
1 parent 49a247b commit fd989d9

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ It's written responsibly to only trigger rebuilds if git metadata changes (e.g.
55
The core capability is baked into single self-contained
66
[script](git_watcher.cmake).
77

8+
## Requirements
9+
- CMake >= 3.2
10+
- C Compiler (with C99 standard support)
11+
- Git
12+
813
## Quickstart via FetchContent
914
You can use CMake's `FetchContent` module to build the static library `cmake_git_version_tracking`:
1015
```

git.h

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
#define GIT_VERSION_TRACKING_EXTERN_C_END
1616
#endif
1717

18+
// Don't mangle the C function names if included in a CXX file.
1819
GIT_VERSION_TRACKING_EXTERN_C_BEGIN
1920

2021
/// Is the metadata populated?
@@ -57,9 +58,9 @@ GIT_VERSION_TRACKING_EXTERN_C_END
5758

5859
#ifdef __cplusplus
5960

60-
/// This is a utility extension for C++ units.
61+
/// This is a utility extension for C++ projects.
6162
/// It provides a "git" namespace that wraps the
62-
/// C methods in more ergonomic types.
63+
/// C methods in more(?) ergonomic types.
6364
///
6465
/// This is header-only in an effort to keep the
6566
/// underlying static library C99 compliant.

0 commit comments

Comments
 (0)