diff options
author | Shevek <[email protected]> | 2014-01-17 22:06:03 -0800 |
---|---|---|
committer | Shevek <[email protected]> | 2014-01-17 22:06:03 -0800 |
commit | c084e7c1b45b494bf5ebfcc5f866a39bc661de73 (patch) | |
tree | a9f03529ceb7959f06a98875b19f4196b89a2d8d /README.md | |
parent | ca42036955f2589d034a688267eb81c5da2c824d (diff) |
Update README.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 20 |
1 files changed, 20 insertions, 0 deletions
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/) |