about summary refs log tree commit diff homepage
path: root/www
diff options
context:
space:
mode:
authorDaniel Dunbar <daniel@zuster.org>2009-05-21 04:36:41 +0000
committerDaniel Dunbar <daniel@zuster.org>2009-05-21 04:36:41 +0000
commit6f290d8f9e9d7faac295cb51fc96884a18f4ded4 (patch)
tree46e7d426abc0c9f06ac472ac6f7f9e661b5d78cb /www
parenta55960edd4dcd7535526de8d2277642522aa0209 (diff)
downloadklee-6f290d8f9e9d7faac295cb51fc96884a18f4ded4.tar.gz
Initial KLEE checkin.
 - Lots more tweaks, documentation, and web page content is needed,
   but this should compile & work on OS X & Linux.


git-svn-id: https://llvm.org/svn/llvm-project/klee/trunk@72205 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'www')
-rw-r--r--www/Examples.html34
-rw-r--r--www/GetInvolved.html34
-rw-r--r--www/GetStarted.html101
-rw-r--r--www/bugs.html2
-rw-r--r--www/content.css20
-rw-r--r--www/index.html4
-rw-r--r--www/install.html2
-rw-r--r--www/menu.html.incl7
-rw-r--r--www/tutorials.html4
9 files changed, 199 insertions, 9 deletions
diff --git a/www/Examples.html b/www/Examples.html
new file mode 100644
index 00000000..23584053
--- /dev/null
+++ b/www/Examples.html
@@ -0,0 +1,34 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+          "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+<head>
+  <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+  <title>KLEE - Examples</title>
+  <link type="text/css" rel="stylesheet" href="menu.css" />
+  <link type="text/css" rel="stylesheet" href="content.css" />
+</head>
+<body>
+
+<!--#include virtual="menu.html.incl"-->
+
+<div id="content">
+
+<h1>KLEE Examples</h1>
+
+<p>FIXME: Intro.</p>
+
+<h2>Basic Sort Example</h2>
+
+<p>FIXME: Write.</p>
+
+<h2>FIXME: More complicated example</h2>
+
+<p>FIXME: Write: show the important klee.h functions.</p>
+
+<p>FIXME: Write: show the important klee tools.</p>
+
+<p>FIXME: Write: show the important klee options.</p>
+
+</div>
+</body>
+</html>
diff --git a/www/GetInvolved.html b/www/GetInvolved.html
new file mode 100644
index 00000000..b8afcbb3
--- /dev/null
+++ b/www/GetInvolved.html
@@ -0,0 +1,34 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+          "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+<head>
+  <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+  <title>klee - Get Involved</title>
+  <link type="text/css" rel="stylesheet" href="menu.css" />
+  <link type="text/css" rel="stylesheet" href="content.css" />
+</head>
+<body>
+
+<!--#include virtual="menu.html.incl"-->
+
+<div id="content">
+
+<h1>Getting Involved with the klee Project</h1>
+
+<p>FIXME: Intro.</p>
+
+<h2>Mailing Lists</h2>
+
+<p>klee-dev</p>
+
+<p>klee-commits</p>
+
+<h2>Working with the Code</h2>
+
+<p>FIXME: Point at pertinent LLVM docs.</p>
+ 
+<p>FIXME: Point at doxygen.</p>
+
+</div>
+</body>
+</html>
diff --git a/www/GetStarted.html b/www/GetStarted.html
new file mode 100644
index 00000000..07083d4f
--- /dev/null
+++ b/www/GetStarted.html
@@ -0,0 +1,101 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+          "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+<head>
+  <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+  <title>KLEE - Getting Started</title>
+  <link type="text/css" rel="stylesheet" href="menu.css" />
+  <link type="text/css" rel="stylesheet" href="content.css" />
+</head>
+<body>
+
+<!--#include virtual="menu.html.incl"-->
+
+<div id="content">
+
+<h1>Getting Started: Building and Running KLEE</h1>
+
+<!-- <p>FIXME: Intro and disclaimer.</p> -->
+
+<h2 id="build">Building KLEE and Working with the Code</h2>
+
+<p>If you would like to check out and build KLEE, the current procedure is as
+follows:</p>
+
+KLEE is built on LLVM; the first steps are to get a working LLVM
+installation. See <a href="http://llvm.org/docs/GettingStarted.html">Getting
+Started with the LLVM System</a> for more information.
+
+<ol>
+<li>Install llvm-gcc:</li>
+<ul>
+<li>Download and install the LLVM 2.5 release of <tt>llvm-gcc</tt>
+  from <a href="http://llvm.org/releases/download.html">here</a>. It
+  is important to do this first so that it is found in
+  subsequent <tt>configure</tt> steps. <tt>llvm-gcc</tt> will be used
+  later to compile programs that KLEE can execute.</li>
+</ul>
+
+<li><a href="http://www.llvm.org/docs/GettingStarted.html#checkout">Checkout
+    and build LLVM</a> from SVN head:
+    
+  <code class="instr"> <code>
+    svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm
+    cd llvm
+    ./configure --enable-optimized
+    make
+  </code></code>
+
+(the <tt>--enable-optimized</tt> configure argument is not
+necessary, but KLEE runs very slowly in Debug mode).
+  </li>
+
+  <li>Checkout KLEE (to any path you like):
+    <div class="instr">
+      svn co http://llvm.org/svn/llvm-project/klee/trunk klee
+    </div>
+  </li>
+  
+  <li>Configure KLEE (from the KLEE source directory): 
+    <div class="instr">
+      ./configure --with-llvm=<i>path/to/llvm</i>
+    </div>
+    
+    <p>This assumes that you compiled LLVM in-place.  If you used a
+      different directory for the object files then use:
+      <div class="instr">
+	./configure --with-llvmsrc=<i>path/to/llvm/src</i>--with-llvmobj=<i>path/to/llvm/obj</i>
+      </div>
+  </li>
+
+  <li>Build KLEE (from the KLEE source directory):
+    <div class="instr">
+      make
+    </div>
+  </li>
+
+  <li>Run DejaGNU and unit tests to verify your build:
+    <div class="instr">
+      make check<br>
+      make unittests<br>
+    </div>
+  </li>
+
+  <li>You're ready to go!  Go to the <a href="tutorials.html">Tutorials</a> page
+  to try KLEE.</li>
+</ol>
+
+<!--   <h2> Full Installation </h2> -->
+  
+<!--   If you need uCLibc and/or POSIX support add <i>-with-uclibc</i> -->
+<!--   and <i>-enable-posix-runtime</i> to configure.  Thus, to enable -->
+<!--   both, replace step 3 above with: -->
+  
+<!--   <div class="instr"> -->
+<!--     ./configure -with-llvm=<i>path/to/llvm</i> -with-uclibc -enable-posix-runtime ENABLE_OPTIMIZED=1 -->
+<!--   </div> -->
+<!--   However, note that... -->
+
+</div>
+</body>
+</html>
diff --git a/www/bugs.html b/www/bugs.html
index bd5dd86c..fca13033 100644
--- a/www/bugs.html
+++ b/www/bugs.html
@@ -9,7 +9,7 @@
   <link type="text/css" rel="stylesheet" href="content.css">
 </head>
 <body>
-<include virtual="menu.html.incl">
+<!--#include virtual="menu.html.incl"-->
 <div id="content">
   <!--*********************************************************************-->
   <h1>KLEE Bug Reports</h1>
diff --git a/www/content.css b/www/content.css
index caee1f00..9571114d 100644
--- a/www/content.css
+++ b/www/content.css
@@ -1,6 +1,8 @@
 html, body {
   padding:0px;
-  font-size:small; font-family:"Lucida Grande", "Lucida Sans Unicode", Arial, Verdana, Helvetica, sans-serif; background-color: #fff; color: #222;
+  font-size:small; 
+  font-family:"Lucida Grande", "Lucida Sans Unicode", Arial, Verdana, Helvetica, sans-serif; 
+  background-color: #fff; color: #222;
   line-height:1.5;
 }
 
@@ -24,11 +26,23 @@ IMG.img_slide {
 /* Tables */
 tr { vertical-align:top }
 
-/* Code */
-div.code{
+/* Instructions */
+div.instr{
     border: 1px solid LightSteelBlue ;
     font-family: Courier New;
     background-color: #E3E3E3;
     padding: 7px;
     margin: 7px;
 }
+
+/* Code */
+pre.code{
+    display:table;
+    text-align: left;
+    border: 1px solid LightSteelBlue ;
+    font-family: Courier New;
+    background-color: #E3E3E3;
+    margin: 10px;
+    padding: 10px;
+}
+
diff --git a/www/index.html b/www/index.html
index ea60335a..4b9e5f3b 100644
--- a/www/index.html
+++ b/www/index.html
@@ -27,7 +27,9 @@
   the <a href="http://llvm.org/pubs/2008-12-OSDI-KLEE.html">OSDI
   2008</a> paper.</p>
 
+<!--  <p>FIXME: Somewhere need to describe what KLEE can do well and what
+      is more "experimental" or research level. This should also address
+      how KLEE could be used by outside groups (i.e. kleaver).</p> -->
 </div>
-
 </body>
 </html>
diff --git a/www/install.html b/www/install.html
index b01f2105..79aeb4b1 100644
--- a/www/install.html
+++ b/www/install.html
@@ -9,7 +9,7 @@
   <link type="text/css" rel="stylesheet" href="content.css">
 </head>
 <body>
-<include virtual="menu.html.incl">
+<!--#include virtual="menu.html.incl"-->
 <div id="content">
   <!--*********************************************************************-->
   <h1>KLEE Installation Guide</h1>
diff --git a/www/menu.html.incl b/www/menu.html.incl
index 2fbffaef..ef450ca7 100644
--- a/www/menu.html.incl
+++ b/www/menu.html.incl
@@ -6,7 +6,10 @@
   <div class="submenu">
     <label>klee Info</label>
     <a href="index.html">About</a>
-    <a href="install.html">Download &amp; Install</a>
+    <a href="GetStarted.html">Get Started</a>
+    <a href="GetInvolved.html">Get Involved</a>
+    <a href="tutorials.html">Tutorials</a>
+    <a href="Examples.html">Examples</a>
   </div>
 
   <div class="submenu">
@@ -14,5 +17,7 @@
     <a href="http://keeda.stanford.edu/mailman/listinfo/klee-dev">klee-dev</a>
     <a href="http://llvm.org/svn/llvm-project/klee/trunk/">Browse SVN</a>
     <a href="http://llvm.org/viewvc/llvm-project/klee/trunk/">Browse ViewVC</a>
+    <a href="http://t1.minormatter.com/~ddunbar/klee-doxygen/index.html">doxygen</a>
+    <a href="http://t1.minormatter.com/~ddunbar/klee-cov/index.html">Testing Coverage</a>
   </div>
 </div>
diff --git a/www/tutorials.html b/www/tutorials.html
index db5220e4..08e9e4f7 100644
--- a/www/tutorials.html
+++ b/www/tutorials.html
@@ -4,12 +4,12 @@
 <html>
 <head>
   <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-  <title>The klee Symbolic Virtual Machine</title>
+  <title>The KLEE Symbolic Virtual Machine</title>
   <link type="text/css" rel="stylesheet" href="menu.css">
   <link type="text/css" rel="stylesheet" href="content.css">
 </head>
 <body>
-<include virtual="menu.html.incl">
+<!--#include virtual="menu.html.incl"-->
 <div id="content">
   <!--*********************************************************************-->
   <h1>KLEE Tutorials</h1>