about summary refs log tree commit diff homepage
path: root/README.md
diff options
context:
space:
mode:
authorHaneef Mubarak <haneefmubarak@users.noreply.github.com>2014-05-12 22:02:06 -0700
committerHaneef Mubarak <haneefmubarak@users.noreply.github.com>2014-05-12 22:02:06 -0700
commit185c811b1bf643d7876473e05d15c79b66840102 (patch)
tree32cafe7df86d48067907b86cfc5ebf91957bb709 /README.md
parent5d8db05524f5216900e952c3e1fc2aac9c424391 (diff)
downloadklee-185c811b1bf643d7876473e05d15c79b66840102.tar.gz
Update and rename README.txt to README.md
Make it look nicer! :smile:
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..fd724614
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+Klee Symbolic Virtual Machine
+=============================
+
+`klee` is a symbolic virtual machine built on top of the LLVM compiler
+infrastructure. Currently, there are two primary components:
+
+  1. The core symbolic virtual machine engine; this is responsible for
+     executing LLVM bitcode modules with support for symbolic
+     values. This is comprised of the code in lib/.
+
+  2. A POSIX/Linux emulation layer oriented towards supporting uClibc,
+     with additional support for making parts of the operating system
+     environment symbolic.
+
+Additionally, there is a simple library for replaying computed inputs
+on native code (for closed programs). There is also a more complicated
+infrastructure for replaying the inputs generated for the POSIX/Linux
+emulation layer, which handles running native programs in an
+environment that matches a computed test input, including setting up
+files, pipes, environment variables, and passing command line
+arguments.
+
+For further information, see the [webpage](http://klee.github.io/klee/).