Monday, October 11, 2004

Jasmine Ships - ReadMe.txt

We just agreed to release Jasmine to the public today. This was a
pretty intense effort. Andreas and I spent two weeks together to port
the new architecture that we did for MadHatter to Jasmine, and then we
seriously upgraded the meta architecture. The last week has been spent
on documentation (still not ready), debugging, and finishing off as
many loose ends as we could. Interesting that the very last thing we
had to do was decide on the name of this release. We all finally agreed
that this is, in fact, Croquet 0.1. This is to ensure that people
understand that this is an early incomplete version of the system. The
"Jasmine" term is the project/release name, so this will change for
every major release that goes out the door.

As always after a release, I am a bit drained rather than exhilarated.
I tend to dwell on the things that are missing and the problems that
are still in the code. Ignorance is bliss - and I just know too much.
Anyway, here is the Read Me from this release (or a close
approximation):

READ ME - Jasmine 1.0
The Croquet(tm) Developer's Release
-----------------------------------------
The Croquet Committee welcomes you to the Jasmine Developer's Release
of Croquet.

The Croquet Home Page is at http://www.croquetproject.org. Everything related to Croquet is accessible from there, including access to the Croquet system itself.

The Jasmine Developer's Release is intended for people to get their feet wet playing with Croquet. Though most of the system is functional, some key elements are not quite ready and will begin to appear over the next few weeks. This release is really to get you acquainted with the system, deconstruct the examples, and try your own hand at making some things. It is important to note that Croquet is built on top of the Squeak system and includes a complete development environment. In other words, everything you need to develop in Croquet is included as part of this release.

Croquet is an true Open Source project and is covered by an MIT type license. With that in mind, we invite you to participate in the ongoing evolution of the system. You can do this in a number of ways.

First, we have a community mailing list that you should join. You can
do this at:
http://www.croquetproject.org/Community/listserver.html
This is probably the best place to have your questions answered and for you to help others figure out how to extend Croquet.

Second, we have set up a bug tracking system at
http://bugs.impara.de
You will need to register to use this, but it allows you a place to let us know about any problems that you might have.

Third, you can help by providing us with bug fixes, new features, or just new ideas. Many of the things that we use to demo Croquet came from people who had a neat idea that we just had to implement.

Fourth, let us know what you think. In the end, we are doing this for you. We are truly interested in what you think of what we have done, where it could go, and where we failed. Even if you hate the system, let us know - you could well know something we don't. In the end, we can't make Croquet great without your help.

Launching Croquet
-----------------------------------------
Croquet runs on three different platforms - Macintosh, Windows, and Linux. Each of these have slightly different methods for launching the system. Once you are actually running Croquet, all of the systems work identically. All of the Jasmine folders include essentially the same files. The Jasmine1.0.image and Jasmine1.0.changes are where the actual Croquet system is, but we have made it easy for you by supplying a launch icon.

Macintosh: To start Croquet on the Macintosh, just double click on the "Jasmine" app in the folder.

Windows: To start Croquet on Windows, simply double click the "Jasmine" shortcut that you will find in the Jasmine folder.

Linux: To start Croquet on Linux, simply double click or run the "Jasmine.sh" file.

Getting Started
-----------------------------------------
When you start Croquet, you will see three small window icons (along with the license). To jump into Croquet, just click on the icon labeled "First Steps". This takes you to another desktop where you can begin to play.

1) Press the 'update code from server' button OFTEN and REGULARLY. This will keep your system up-to-date with the latest developments (you can also update the system through the world menu, 'help...' submenu). It is extremely likely that by the time you read this, the system will have a number of updates available that may directly address potential problems that you might otherwise have. Don't wait.

2) Drag one of the four objects from the catalog to the center of the main window. The standard Croquet demo can be accessed by dragging the 'Teapot' object (be warned that because of the amount of stuff in the demo - it may take some time for it to completely load - this WILL improve dramatically).

From this point, you can just experiment. For information on how to maneuver through the Croquet system, please check out the web site user guide at:

http://www.croquetproject.org/About_Croquet/userguide.html

Note to Programmers
-----------------------------------------
Croquet is a component-based architecture that makes it extremely quick and easy for you to create useful collaborative objects. The system has been designed from the ground up to make it simple to create truly shared objects of virtually any sort.

For basic information on how to approach programming in Croquet, please
refer to:
http://croquetproject.org/croquetdevelopment/Croquet_Technologies/programmer.html

(Please note that this site does not attempt to teach you how to use the Squeak programming environment, or how to program in OpenGL. There are a number of useful resources available for both of these, includingĂ‚  Squeak: Object-Oriented Design with Multimedia Applications by Mark Guzdial, Prentice-Hall, 2000, and the OpenGL Programming Guide by Mason Woo, Jackie Neider, Tom Davis, and Dave Shreiner, Third Edition. Addison-Wesley. 1999). You will also be able
to download the Croquet Manual from:
http://www.croquetproject.org/Croquet_Technologies/downloads.html

Bug Reports
-----------------------------------------
We have a bug report server running at http://bugs.impara.de. Please let us know of any problems - major or minor.

FAQ
-----------------------------------------
For more information about Croquet and the Jasmine release, the Croquet
FAQ is available at:
http://www.croquetproject.org/About_Croquet/faqs.html

Croquet License
-----------------------------------------
Copyright (c) 2002-2004 by Viewpoints Research Institute, Inc. and other individual, corporate, and institutional contributors who have collectively contributed elements of the Croquet(tm) software code to the Croquet Project. Croquet is a trademark of Viewpoints Research Institute, Inc..

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.




DAS

No comments: