UnmaskedCXX Readme

About ----- UnmaskedCXX is a WIP automatic test generator for C/C++, written in C++11. `SampleCXXProject/` gives an example of an extremely small (header-only) library for which UnmaskedCXX can generate tests. THIS README WILL BE REWRITTEN SOON AS PART OF A DOCS REFACTORING. License ------- Both object and source representations of this software are licensed under CC-BY-NC 4.0. See `LICENSE` for the full text of the license, and https://creativecommons.org/licenses/by-nc/4.0/ for a summary of its terms. For the avoidance of doubt, UnmaskedCXX does not consider a commercial entity running the software in a manner which does not directly produce value, for the purposes of assessment of the software or its Author(s) as "primarily intended for or directed towards commercial advantage or monetary compensation" as stated in Section 1(i) of the license, even when the assessment forms part of a commercial process. We intend for users to be able to run and utilise the software in ways which do not produce value as part of an investigatory process, even if the end result of that investigation has intent to produce commercial advantage or monetary compensation. If you wish to use UnmaskedCXX under the terms of another license, please e-mail Jamie Line (`jamietline@gmail.com`) to discuss. Contributing ------------ At this time, UnmaskedCXX is not actively looking for contributors. Requirements ------------ To run UnmaskedCXX, you will require CMake (at least version 3.12), and a C++11 compiler. To develop UnmaskedCXX, you will also require pre-commit, clang-format, and clang-tidy.