diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 9 |
1 files changed, 8 insertions, 1 deletions
@@ -8,11 +8,18 @@ A C code mutator,Misra-C 2004 checker and when possible, a Misra-C implementer.< The **utility** folder holds the C source and headers that are necessary to run the instruented code(currently unused).<br/> **mutator-aux.cpp.h** hold the auxillary functions that most modules will need.<br/> Well there is the **makefile**.<br/> -The **test** folder holds the TDD tests.<br/> +The **test** folder holds the **TDD** tests.<br/> +###Building mutator To build the project, you need to have the LLVM libraries 4.0 to avoid any unforseen results. The project ccan not be built with LLVM 3.8 or lower, but I havent tested LLVM 3.9. Just run **make** and you're good to go. Running make will build three executables which can be used independently or with **mutator.sh**(use -h to see a list of options.)<br/> +The makefile uses **clang++ 4.0** as the compiler to build the project. On paper, any latest version of g++ should do the trick but this remains untested.<br/> **mutator-lvl0** will run the Misra-C:2004 checks.<br/> **mutator** will run the level-1 Misra-C:2004 implementers.<br/> **mutator-lvl2** will run the level-2 Misra-C:2004 implementers.<br/> Currently, the mutation-only features(mutation for the sake of mutation, technically implementing Misra-C is also a form of mutation) are turned off in **mutator** and **mutator-lvl2**.<br/> If your code needs a compilation database for clang to understand it and you don't have one,you can use [Bear](https://github.com/rizsotto/Bear).<br/> + +### Notes +I'm using **TDD** as the Dev method. The files under the **test** folder are for that purpose. They are not unit tests or are not meant to test that the build process was successful.<br/> +The project has been tested to biuld on Fedora23(other major linux distros should be fine). Windows remains untested. I might give it a try when I feel masochistic enough.<br/> +The project might, at a later point in time, start using **Cmake** for the build process. Currently there are no plans,though.<br/> |