Skip to content

Commit

Permalink
docs: improve the project description in README.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
threeal committed Jul 5, 2024
1 parent 415ac6f commit b08979c
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,22 @@
# Assertion.cmake

A [CMake](https://cmake.org/) module containing a collection of assertion functions for testing purposes.
A [CMake](https://cmake.org/) module containing a collection of assertion
functions and other utilities for testing CMake code.

The main feature of the `Assertion.cmake` module is the `assert` function, which
asserts the given condition in the style of CMake's
[`if`](https://cmake.org/cmake/help/latest/command/if.html) function. If the
assertion fails, it throws a fatal error message with information about the
context of the asserted condition.

The `Assertion.cmake` module also supports
[CMake test](https://cmake.org/cmake/help/book/mastering-cmake/chapter/Testing%20With%20CMake%20and%20CTest.html)
creation using the `assertion_add_test` function. This function creates a new
test that processes the given file in script mode with variables, functions, and
macros from the `Assertion.cmake` module available in the test file.

If the `Assertion.cmake` module is processed in script mode, it can optionally
include other modules by passing their paths as additional arguments after `--`.

## Key Features

Expand Down

0 comments on commit b08979c

Please sign in to comment.