changeset 14:872076165de4

More excludes and add missing documentation.
author Dan Creswell <dan.creswell@gmail.com>
date Sun, 05 Jul 2009 16:20:46 +0100
parents 3d83b0e0b75a
children cd96fcac1487
files .hgignore index.html
diffstat 2 files changed, 119 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/.hgignore	Sun Jun 14 20:25:45 2009 +0100
+++ b/.hgignore	Sun Jul 05 16:20:46 2009 +0100
@@ -2,6 +2,7 @@
 docs/javadocs/
 examples/.*\.class
 lib/
+dbfiles*/.*
 
 # Eclipse-specific ignores
 .classpath
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/index.html	Sun Jul 05 16:20:46 2009 +0100
@@ -0,0 +1,118 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+  <title>Blitz JavaSpaces (Pure Java Edition) Documentation</title>
+
+
+</head>
+
+
+<body>
+
+<h1>Blitz Documentation</h1>
+
+<p><a href="docs/blitz.html">Overview</a> -
+About Blitz </p>
+
+<p><a href="docs/install_guide.html">Install Guide</a>
+- To run Blitz.</p>
+
+<p><a href="http://www.dancres.org/blitz/blitz_js_faq.html">FAQ</a>
+- Online.</p>
+
+<p><a href="docs/tools.html">Tools Guide</a> -
+Standard utilities including dashboard.</p>
+
+<p><a href="docs/serviceui.html">ServiceUI Support</a>
+- For ServiceUI related options.</p>
+
+<p><a href="docs/dev_guide.html">Developers Guide</a>
+- For Blitz system developers and those wishing to build from source.</p>
+
+<p><a href="docs/hello_example.html">Simple Example</a>
+- Provides a simple helloworld-style example of a JavaSpaces
+application.</p>
+
+<p><a href="docs/javadocs/index.html">API
+Documentation</a> - For Javadocs.</p>
+
+<p><a href="docs/extensions.html">Blitz Extensions</a>
+- Blitz-specific features.</p>
+
+<p><a href="docs/tuning.html">Blitz Tuning</a>
+- How to get the best out of Blitz.</p>
+
+<p><a href="docs/future_limits.html">Future Work and
+Limitations</a> - What's next for Blitz.</p>
+
+<p><a href="docs/LICENSE.TXT">License</a> -
+and how it <a href="docs/licensing.html">affects you</a>.</p>
+
+<p><a href="docs/required_packages.html">Required
+Packages</a> - What you need to run or compile blitz</p>
+
+<p><a href="docs/contrib.html">Contrib</a> -
+Useful bits and pieces submitted by Blitz users</p>
+
+<p><a href="docs/feedback.html">Reporting Bugs,
+Providing Feedback or Asking Questions</a> - Checklists and email
+addresses</p>
+
+<p><a href="http://www.dancres.org/blitz/">Blitz
+Project Website</a> - For news, updates and new releases.</p>
+
+<h2>Platform Specific Notes</h2>
+
+<p><a href="docs/mac_osx.html">Mac OS X</a> -
+Important notes for running Blitz (compulsory reading).</p>
+
+<p><a href="docs/linux.html">Linux</a> - Notes
+on tuning (optional reading).</p>
+
+<h2>Credits</h2>
+
+<p>Blitz contains source code from <a href="http://www.prevayler.org">Prevayler 1.02</a> and
+<a href="http://gee.cs.oswego.edu/dl/classes/EDU/oswego/cs/dl/util/concurrent/intro.html">Doug
+Lea's concurrency package</a>.
+</p>
+
+<p>The Prevayler source code is not quite original as it has been
+modified to support several different Prevayler types, optional
+FD.sync() calls, asynchronous checkpointing, buffering and
+programmatical control of objectoutputstream::reset. With kind
+permission from Klaus Wuestefeld this code is licensed under the
+revised BSD license.
+</p>
+
+<p>Blitz also makes use of <a href="http://sourceforge.net/projects/teatrove/">Disney's
+Trove 1.3.0</a> (note that the distribution in the source tree is
+not the most up to date and was modified to compile correctly under JDK
+1.4.x. Trove is licensed <a href="docs/disney_lic.txt">under
+the following terms</a>
+</p>
+
+<p>Thanks to all these projects for making my life easier!</p>
+
+<p>Blitz uses Berkeley DB Java Edition for persistence (<a href="docs/db_license.html">License</a>). Thanks to
+everyone at <a href="http://www.sleepycat.com/">Sleepycat</a>.
+The source code for Db Java Edition is available from <a href="http://www.sleepycat.com">SleepyCat.</a>
+</p>
+
+<p>Thanks to Nigel Warren and Phil Bishop for contributing a
+great test suite in the form of the source code for all the examples in
+their book, "<a href="http://www.djip.co.uk/jsipinfo/">JavaSpaces
+in Practice</a>". Special thanks to Phil for doing the initial
+testing with the examples which allowed me to concentrate on fixing the
+bugs.</p>
+
+<p>Integration with Inca X, the associated installer and the
+ServiceUI support in Dashboard was almost entirely the work of the <a href="http://www.incax.com">Inca X team</a> - a big
+thank you to them.</p>
+
+<p>Lastly, thanks to Nimrod Megiddo and Dharmendra S. Modha at
+IBM Almaden for designing <a href="http://citeseer.nj.nec.com/megiddo03arc.html">ARC</a>
+and publishing an article in <a href="http://www.usenix.org/publications/login/">;Login:
+magazine</a> which set me thinking.....</p>
+
+</body>
+</html>