diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..9972a0b2f55f70674f91b747253e16f1e328bd30 --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ + +This is a library to parse ELF's exception handling information out of its binary form and into it's "parse tree" form. + +The API is documented in the include directory. The source tree is complicated and understanding it should not be necessary. + +The test directory contains a simple example of how to use the API. + +Notes: + +1. Compilation requires C++11 or later. +1. Additional documentation will be provided in later versions +1. API is incomplete and untested in some areas. Future versions will improve stability.