Updated readme, licenses, removed some spurious debug lines

Jonathan Bell [2012-08-17 13:32:29]
Updated readme, licenses, removed some spurious debug lines
Filename
Code/ChroniclerJ/lib/asm-license
Code/ChroniclerJ/lib/asm-src.zip
Code/ChroniclerJ/license.md
Code/ChroniclerJ/src/edu/columbia/cs/psl/chroniclerj/Main.java
README.md
diff --git a/Code/ChroniclerJ/lib/asm-license b/Code/ChroniclerJ/lib/asm-license
new file mode 100644
index 0000000..c5aba7b
--- /dev/null
+++ b/Code/ChroniclerJ/lib/asm-license
@@ -0,0 +1,29 @@
+Copyright (c) 2000-2011 INRIA, France Telecom
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holders nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/Code/ChroniclerJ/lib/asm-src.zip b/Code/ChroniclerJ/lib/asm-src.zip
deleted file mode 100644
index 2fcfff5..0000000
Binary files a/Code/ChroniclerJ/lib/asm-src.zip and /dev/null differ
diff --git a/Code/ChroniclerJ/license.md b/Code/ChroniclerJ/license.md
new file mode 100644
index 0000000..0408e9e
--- /dev/null
+++ b/Code/ChroniclerJ/license.md
@@ -0,0 +1,19 @@
+This software is released under the MIT license:
+
+Copyright © 2012, by The Trustees of Columbia University in the City of New York.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+
+This project makes use of the following libraries:
+* [ASM](http://asm.ow2.org/license.html), (c) 2000-2011 INRIA, France Telecom, [license](http://asm.ow2.org/license.html)
+* [Cloning](https://code.google.com/p/cloning/), (c) 2009 Konstantinos Kougios, released under the Apache License 2.0
+* [KXML2](http://kxml.sourceforge.net/kxml2/), (c) 1999-2005, Stefan Haustein, released under the BSD license
+* [Objenesis](http://code.google.com/p/objenesis/), © 2006-2012, Joe Walnes, Henri Tremblay and Leonardo Mesquita, released under the Apache License 2.0
+* [Log4j](http://logging.apache.org/log4j/), (c) 1999-2012, Apache Software Foundation, released under the Apache License 2.0
+* [XStream](http://xstream.codehaus.org/, (c) 2003-2006, Joe Walnes and (c) 2006-2009, 2011 XStream Committers, released under [a BSD license](http://xstream.codehaus.org/license.html)
diff --git a/Code/ChroniclerJ/src/edu/columbia/cs/psl/chroniclerj/Main.java b/Code/ChroniclerJ/src/edu/columbia/cs/psl/chroniclerj/Main.java
index 79338b8..6fb2215 100644
--- a/Code/ChroniclerJ/src/edu/columbia/cs/psl/chroniclerj/Main.java
+++ b/Code/ChroniclerJ/src/edu/columbia/cs/psl/chroniclerj/Main.java
@@ -24,7 +24,6 @@ public class Main {
 				argOffset++;
 				Constants.MAX_LOG_SIZE=Integer.parseInt(args[1].replace("-mxLog", ""));
 			}
-			System.out.println("Offset " + argOffset);
 			String[] instrumenterArgs = new String[args.length-1- argOffset];

 			instrumenterArgs[0] = args[1+argOffset];
@@ -33,7 +32,6 @@ public class Main {
 			for (int i = 4+argOffset; i < args.length; i++) {
 				instrumenterArgs[i-argOffset] = args[i];
 			}
-			System.out.println(Arrays.deepToString(instrumenterArgs));
 			Instrumenter._main(instrumenterArgs);
 			Replayer._main(new String[] { args[1+argOffset], args[3+argOffset] });
 		}
diff --git a/README.md b/README.md
index 2286996..3e69e6e 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,80 @@
 ChroniclerJ [Chronicler implemented in Java]
 =======

-Lightweight Recording of Nondeterministic Inputs to Reproduce Field Failures
+*Lightweight Recording of Nondeterministic Inputs to Reproduce Field Failures*

-For more information, see our Technical Report:
-http://mice.cs.columbia.edu/getTechreport.php?techreportID=1512&format=pdf
\ No newline at end of file
+**ChroniclerJ** is a system for recording buggy program executions in the field and reproducing them in the lab. **ChroniclerJ** is our Java implementation of **Chronicler**, a generalized record and replay approach for VM-based languages.
+
+This repository contains the source and a [runnable binary](https://github.com/Programming-Systems-Lab/chroniclerj/blob/master/chroniclerj-0.4.jar) for **ChroniclerJ**.
+
+###For more information
+Please see our Technical Report:
+<http://mice.cs.columbia.edu/getTechreport.php?techreportID=1512&format=pdf>, or email [Jonathan Bell](mailto:jbell@cs.columbia.edu)
+
+Running
+-----
+### Instrumenting your code
+Before deploying your code, you need to run the **ChroniclerJ** instrumenter, which will produce two copies of your program: one for deployment (with logging code), and one for replay purposes (with code that reads back from the log).
+
+To run the instrumenter, use the command `java -jar chroniclerj-0.4.jar -instrument {-mxLogN} input ouputLocationDeploy outputLocationReplay`, where:
+* `{-mxLogN}` is an optional parameter indiciating that at most `N` items should be stored in the in-memory logfile before it is flushed to disk
+* `input` is the path that contains the .class files, .jar files, etc that need to be instrumented (e.g. what you would be deploying normally)
+* `outputLocationDeploy` is where you would like the generated code (for deployment) to be placed
+* `outputLocationReplay` is where you would like the generated code (for running replays) to be placed
+
+It is important that *all* libraries that you plan to deploy with your application are instrumented. We suggest running the instrumenter at the top level folder that you were going to deploy, which might contain several jar files, several class files, etc.
+
+### Collecting test cases
+Deploy your code as you normally would, but deploy the code that was instrumented and placed in `outputLocationDeploy` rather than your original, uninstrumented code. Make sure that the **ChroniclerJ** jar is in your classpath too.
+
+When an uncaught exception ocurrs, **ChroniclerJ** generates a test case. You can manually invoke this process (e.g. from your own exception handler) by calling the method `ChroniclerJExceptionRunner.genTestCase()`. Users are notified that a test case was generated, which is placed in the current working directory and has the name format chroniclerj-crash-*currenttime*.test. The test case file contains all logs necessary to replay the execution.
+
+### Replaying test cases
+To replay the failed executions, run the command `java -jar chroniclerj-0.4.jar -replay testCase {classpath}`, where
+* `testCase` is the test case to run
+* `{classpath}` is a space-delimited classpath passed to your program when it starts to replay
+
+Building
+-----
+**ChroniclerJ** is an eclipse project, and should simply be added to eclipse, and built as a Java project.
+
+###Packaging
+To create the **ChroniclerJ** jar, first run the `unpackLibs.sh` command to unpack the libraries that **ChroniclerJ** depends on, then `makeJar.sh` to generate a jar file with **ChroniclerJ** and its libraries embedded.
+
+License
+------
+This software is released under the MIT license.
+
+Copyright (c) 2012, by The Trustees of Columbia University in the City of New York.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+Acknowledgements
+-----
+This project makes use of the following libraries:
+* [ASM](http://asm.ow2.org/license.html), (c) 2000-2011 INRIA, France Telecom, [license](http://asm.ow2.org/license.html)
+* [Cloning](https://code.google.com/p/cloning/), (c) 2009 Konstantinos Kougios, released under the Apache License 2.0
+* [KXML2](http://kxml.sourceforge.net/kxml2/), (c) 1999-2005, Stefan Haustein, released under the BSD license
+* [Objenesis](http://code.google.com/p/objenesis/), © 2006-2012, Joe Walnes, Henri Tremblay and Leonardo Mesquita, released under the Apache License 2.0
+* [Log4j](http://logging.apache.org/log4j/), (c) 1999-2012, Apache Software Foundation, released under the Apache License 2.0
+* [XStream](http://xstream.codehaus.org/, (c) 2003-2006, Joe Walnes and (c) 2006-2009, 2011 XStream Committers, released under [a BSD license](http://xstream.codehaus.org/license.html)
+
+The authors of this software are [Jonathan Bell](http://jonbell.net), [Nikhil Sarda](https://github.com/diffoperator/) and [Gail Kaiser](http://www.cs.columbia.edu/~kaiser/). The authors are members of the [Programming Systems Laboratory](http://www.psl.cs.columbia.edu/), funded in part by NSF CCF-1161079, NSF CNS-0905246 and NIH 2 U54 CA121852-06.
\ No newline at end of file