Adding example source to support MCJIT/Kaleidoscope blog posts.

[oota-llvm.git] / examples / Kaleidoscope / MCJIT / lazy / README.txt

diff --git a/examples/Kaleidoscope/MCJIT/lazy/README.txt b/examples/Kaleidoscope/MCJIT/lazy/README.txt
new file mode 100644 (file)
index 0000000..c5c271e
--- /dev/null
+++ b/examples/Kaleidoscope/MCJIT/lazy/README.txt
@@ -0,0 +1,25 @@
+//===----------------------------------------------------------------------===/
+//                          Kaleidoscope with MCJIT
+//===----------------------------------------------------------------------===//
+
+The files in this directory are meant to accompany the first in a series of
+three blog posts that describe the process of porting the Kaleidoscope tutorial
+to use the MCJIT execution engine instead of the older JIT engine.
+
+When the blog post is ready this file will be updated with a link to the post.
+
+The source code in this directory demonstrates the second version of the
+program, now modified to implement a sort of 'lazy' compilation.
+
+The toy-jit.cpp file contains a version of the original JIT-based source code
+that has been modified to disable most stderr output for timing purposes.
+
+This directory contain a Makefile that allow the code to be built in a
+standalone manner, independent of the larger LLVM build infrastructure. To build
+the program you will need to have 'clang++' and 'llvm-config' in your path. If
+you attempt to build using the LLVM 3.3 release, some minor modifications will
+be required.
+
+This directory also contains a Python script that may be used to generate random
+input for the program and test scripts to capture data for rough performance
+comparisons.
\ No newline at end of file