summaryrefslogtreecommitdiff
path: root/projects/SmallExamples/ModuleMaker/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'projects/SmallExamples/ModuleMaker/README.txt')
-rw-r--r--projects/SmallExamples/ModuleMaker/README.txt9
1 files changed, 9 insertions, 0 deletions
diff --git a/projects/SmallExamples/ModuleMaker/README.txt b/projects/SmallExamples/ModuleMaker/README.txt
new file mode 100644
index 00000000000..877cf8fb98a
--- /dev/null
+++ b/projects/SmallExamples/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.