diff --git a/README.md b/README.md index fe0fe57..b99034a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,69 @@ # jtest - Dead Simple Modern C++ Unit Testing \ No newline at end of file + Dead Simple Modern C++ Unit Testing + +![Static Badge](https://img.shields.io/badge/Lit-Based-%20) + +## Features +* Macro free, gluten free, cruelty free unit testsuite! +* Colored output! +* Single header!! +* Modern C++ (C++20) +* Public Domain +* Dead simple! + +## Installation + +Include this repository as a CPM dependency, and link against the library. + +```cmake +CPMAddPackage( + NAME jtest + URL https://git.redacted.cc/josh/jtest/archive/Prerelease-1.zip +) +# ... +include_directories(${jtest_SOURCE_DIR}/include) +# ... +target_link_libraries(YourProgram ... jtest) +``` + +## Usage + +Using jtest is simple! Dead simple! + +```cpp +#include "include/jtest/jtest.hpp" + +int main(int argc, char** argv) +{ + TEST("Test1", []{ + jtest::check(2+2 == 4); + }); + + TEST("Test2", [] { + jtest::check(2+2 == 4); + }); + + TEST("Test3", [] + { + jtest::check(6+9 == 69); + }); + + jtest::run_tests(); +} +``` + +## Output + +![Should be sample output...](img.png) + +## License + +This software is written and developed by Josh O'Leary @ Redacted Software 2024. This work is dedicated to the public domain. + +## Contributing + +Send'em pull requests. + +## Special Thanks +* Maxine Hayes \ No newline at end of file diff --git a/img.png b/img.png new file mode 100644 index 0000000..006af5b Binary files /dev/null and b/img.png differ