From c084e7c1b45b494bf5ebfcc5f866a39bc661de73 Mon Sep 17 00:00:00 2001 From: Shevek Date: Fri, 17 Jan 2014 22:06:03 -0800 Subject: Update README. --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..03b27ff --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# Introduction + +The C Preprocessor is an interesting standard. It appears to be +derived from the de-facto behaviour of the first preprocessors, and +has evolved over the years. Implementation is therefore difficult. + +JCPP is a complete, compliant, standalone, pure Java implementation +of the C preprocessor. It is intended to be of use to people writing +C-style compilers in Java using tools like sablecc, antlr, JLex, +CUP and so forth (although if you aren't using sablecc, you need your +head examined). + +This project has has been used to successfully preprocess much of +the source code of the GNU C library. As of version 1.2.5, it can +also preprocess the Apple Objective C library. + +# Documentation + +* [JavaDoc API](http://shevek.github.io/jcpp/docs/javadoc/) +* [Coverage Report](http://shevek.github.io/jcpp/docs/cobertura/) -- cgit v1.2.3