https://github.com/codylico/reedkiln
Unit testing library
https://github.com/codylico/reedkiln
c cxx11 unit-testing
Last synced: over 1 year ago
JSON representation
Unit testing library
- Host: GitHub
- URL: https://github.com/codylico/reedkiln
- Owner: codylico
- License: unlicense
- Created: 2022-05-11T04:41:52.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-11T00:49:05.000Z (almost 2 years ago)
- Last Synced: 2025-02-05T01:30:06.984Z (over 1 year ago)
- Topics: c, cxx11, unit-testing
- Language: C
- Homepage:
- Size: 117 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# reedkiln
The `reedkiln` library aims to provide unit testing with minimal macros.
Output follows the [Test Anything Protocol](https://testanything.org/)
for easier integration with other existing tools.
As a library that avoids macros, it therefore lacks any test creation
domain-specific language (DSL). Depending on the use case, this may
be a welcome feature or an undesirable gap.
## Goals
- Minimal C macro usage
- Test Anything Protocol support
- Optional logging support
- Cross-platform
- Small code footprint
## Build
This project uses CMake for building. Developers can obtain CMake from
the following URL:
[https://cmake.org/download/](https://cmake.org/download/)
To use CMake with this project, first create a directory to hold the build
results. Then run CMake in the directory with a path to the source code.
On UNIX, the commands would look like the following:
```
mkdir build
cd build
cmake ../reedkiln
```
Running CMake should create a build project, which then can be processed
using other tools. Usually, the tool would be Makefile or a IDE project.
For Makefiles, use the following command to build the project:
```
make
```
For IDE projects, the IDE must be installed and ready to use. Open the
project within the IDE.
Since this project's source only holds two required files (`reedkiln.h`
and `reedkiln.c`) and one optional header file (`log.h`), developers
could also use these files independently from CMake.
## License
This project uses the Unlicense, which makes the source effectively
public domain. Go to [http://unlicense.org/](http://unlicense.org/)
to learn more about the Unlicense.
Contributions to this project should likewise be provided under a
public domain dedication.