Add description to FuzzyPP readme.md (#173)

* Add description to FuzzyPP readme.md FuzzyPP can resolve macro definitions and #include preprocessor directives. Provide the preprocessor with a list of defines, undefines and include files/paths. When the preprocessor finds an #include, it will try to find it in the list of files/paths specified by the user. If it is found, then it is substituted with the contents of the file, otherwise the include is omitted. Note: FuzzyPP has not been exhaustively tested, and hasn't been tested on MacOS, and is offered for BETA testing use in a non-production manner. * Update README.md Co-authored-by: Jacob Taylor-Hindle <[email protected]>
ShiftLeftSecurity · Jan 6, 2020 · 7bca498 · 7bca498
1 parent ce36b28
commit 7bca498
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/fuzzypp/README.md b/fuzzypp/README.md
@@ -4,6 +4,10 @@ Fuzzy PP
 FuzzyPP provides users with the ability to preprocess a set of input C/C++ files for use with the ShiftLeft 
 `fuzzyc2cpg` system.
 
+FuzzyPP can resolve macro definitions and #include preprocessor directives. It is also possible to provide the preprocessor with a list of defines, undefines and include files/paths. When the preprocessor encounters an #include statement, it will try to find it in the list of include files/paths specified by the user. If the include file is found, then it is substituted with the contents of the file, otherwise the include statement is omitted.
+
+Note: FuzzyPP has been tested on Windows and Linux with some select projects, but this has not been exhaustive. As a result, this is **beta** software and is not recommended for use in production systems.
+
 Compiling
 ---