.loci.0.1.source-code.README Maven / Gradle / Ivy

Go to download
//////////////////////////////////////////////////////
//                   WHAT IS LOCI?                  //
//////////////////////////////////////////////////////

The Loci system proposes a simple, statically checkable set of annotations that
lets programmers express thread-locality.



//////////////////////////////////////////////////////
//                 HOW TO USE LOCI?                 //
//////////////////////////////////////////////////////

To use Loci, you need to install the checker framework, for more information
refere to this page:

	http://types.cs.washington.edu/checker-framework/

And, in order to install the checker framework, please read this section:

	http://types.cs.washington.edu/checker-framework/#installation

Once, you have isntalled the checker framework successfully, put (dist/Loci-0.1.jar) 
into your CLASSPATH.

Or alternatively, visit this page for instructions:

	http://java.net/projects/loci/pages/Home#Installing_Loci

Please make sure, that (checkers.jar, and jsr308-all.jar) are in your classpath,
if you couldn't find them, you can find them in the (dist/lib) directory of this
distribution.

To run Loci, you need to pass the LociChecker processor to the checker framework's javac:

	example: javac -processor loci.LociChecker examples/HelloWorld.java
	
Please refer to the (manual/manual.pdf) to know more about Loci system.

Or, visit Loci's homepage:

		http://loci.java.net

//////////////////////////////////////////////////////
//             BUILDING FROM THE SOURCE             //
//////////////////////////////////////////////////////

To rebuild Loci from the source, you need:

	- Apache Ant version 1.8.0 or above (http://ant.apache.org/)
	- OpenJDK 7 or above (http://openjdk.java.net/projects/jdk7/)
	- Checker framework (JSR308 1.1.2) or above (http://types.cs.washington.edu/checker-framework) 
	- In the command line, enter: $ ant jar
	
//////////////////////////////////////////////////////
//          OTHER OPTIONS AND MORE INFO             //
//////////////////////////////////////////////////////

- To run, write or maintain the test cases, please read (tests/README)
- To build the javadoc:
	ant api
- To re-generate the manual:
	ant manual-pdf
	
	
//////////////////////////////////////////////////////
//                   USEFUL LINKS                   //
//////////////////////////////////////////////////////

- Loci's webpage: http://www.it.uu.se/research/upmarc/loci
- Loci's wiki: http://java.net/projects/loci/pages/Home
- Loci's forum: http://java.net/projects/loci/forums
- Loci's repository: http://java.net/projects/loci/sources/main/show
- Loci's issue tracking: http://java.net/bugzilla/buglist.cgi?product=loci&order=Importance&limit=25
- Loci's mailing lists: http://java.net/projects/loci/lists