From 950cf8644cda08d331372a5b65cadaf2cc9dea88 Mon Sep 17 00:00:00 2001 From: bloodstalker Date: Wed, 30 Nov 2016 12:52:20 +0330 Subject: xml out announcement --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c220740..eeddbf5 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ A C code mutator,Misra-C 2004 checker and when possible, a Misra-C implementer.< **mutator.cpp** contains the mutators which are not copiled for the time being since im working on Misra-C only for the time being, along with some Misra-C implementers.
**mutator-lvl2.cpp** contains some other Misra-C implementers. Rewriting the code in multiple stages allows for more simplistic rewrites and is also a check to see whether the output is actually buildable.
**mutator.sh** is the UI, which is supposed to work like just any other nix UI(option-wise).
-The **utility** folder holds the C source and headers that are necessary to run the instruented code(currently unused).
+The **utility** folder holds the C source and headers that are necessary to run the instrumented code(currently unused).
**mutator-aux.cpp.h** hold the auxillary functions that most modules will need.
Well there is the **makefile**.
The **test** folder holds the **TDD** tests.
@@ -22,7 +22,7 @@ If your code needs a compilation database for clang to understand it and you don ### Notes #### **The project will be updated everytime there is a major LLVM release and will use those libraries instead of the old ones.** -#### **Support for XML output report for the Misra-C:2004 rule-checker coming soon.** +Misra-C rule checker outputs a simple text or xml report. JSON support will be implemented in the future.
I'm using **TDD**. 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.Those tests will be added later.
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.
The project might, at a later point in time, start using **Cmake** for the build process. Currently there are no plans,though.
-- cgit v1.2.3