Initial checkin

[oota-llvm.git] / examples / ModuleMaker / README.txt

diff --git a/examples/ModuleMaker/README.txt b/examples/ModuleMaker/README.txt
new file mode 100644 (file)
index 0000000..877cf8f
--- /dev/null
+++ b/examples/ModuleMaker/README.txt
@@ -0,0 +1,9 @@
+//===----------------------------------------------------------------------===//
+//                         ModuleMaker Sample project
+//===----------------------------------------------------------------------===//
+
+This project is a extremely simple example of two things: building an LLVM
+"project" and using some simple pieces of the LLVM API.  The actual executable
+generated by this project simply emits an LLVM bytecode file to standard output.
+It is designed to show some basic usage of LLVM APIs, and how to link to LLVM
+libraries.