Skip to content

Commit 5ae2cb7

Browse files
committed
Add v0.x highlights
1 parent 2833d16 commit 5ae2cb7

File tree

1 file changed

+73
-1
lines changed

1 file changed

+73
-1
lines changed

docs/+current/01_release-notes.md

Lines changed: 73 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,79 @@ _N/A - "Not available"._
2424

2525
## `v0.x` Highlights
2626

27-
_TODO: ...incomplete, please review documentation at a later point_
27+
### "Mini" Testing Framework
28+
29+
(_available since `v0.1`_)
30+
31+
A "mini" testing framework for testing your CMake modules and scripts.
32+
33+
```cmake
34+
define_test("has built assets" "has_built_assets")
35+
function(has_built_assets)
36+
assert_file_exists("resources/images/menu_bg.png" MESSAGE "No menu bg")
37+
assert_file_exists("resources/images/bg.png" MESSAGE "No background")
38+
39+
# ...etc
40+
endfunction()
41+
```
42+
43+
See [testing module](./modules/testing/cmake/index.md) for additional information.
44+
45+
### Git
46+
47+
(_available since `v0.1`_)
48+
49+
Git related utilities.
50+
51+
```cmake
52+
git_find_version_tag(
53+
OUTPUT version
54+
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
55+
)
56+
57+
message("${version}") # 1.15.2
58+
```
59+
60+
See [git module](./modules/git/index.md) for additional information.
61+
62+
### Version
63+
64+
(_available since `v0.1`_)
65+
66+
Helpers for dealing with a project’s versioning
67+
68+
```cmake
69+
version_from_file(
70+
FILE "version"
71+
OUTPUT my_package
72+
)
73+
74+
message("${my_package}_SEMVER") # 2.0.0-beta.3+AF1004
75+
```
76+
77+
See [version module](./modules/version/index.md) for additional information.
78+
79+
### Cache
80+
81+
(_available since `v0.1`_)
82+
83+
Module that offers additional caching functionality (_via CMake’s Cache Entry mechanism_).
84+
85+
```cmake
86+
cache_set(
87+
KEY foo
88+
VALUE "bar"
89+
TTL 5
90+
)
91+
92+
# ... Elsewhere in your cmake scripts, 5 seconds later...
93+
94+
cache_get(KEY foo)
95+
96+
message("${foo}") # (empty string)
97+
```
98+
99+
See [cache module](./modules/cache/index.md) for additional information.
28100

29101
## Changelog
30102

0 commit comments

Comments
 (0)