README for SATINv2.2
http://guir.berkeley.edu/projects/satin

Jason I. Hong (jasonh@cs.berkeley.edu)
Feb 11, 2001

--------------------------------------------------------------------------------

INTRO
-----

SATIN is a toolkit for making informal ink-based applications, ones that let
you quickly sketch out things and have some recognition going on.

This is the release for SATIN, which contains:
   - satin-v2.2.jar, the Java JAR file of compiled classes and source code
   - quill.jar, a tool for designing new gestures
   - data/, a folder that contains a few gesture files that we've defined

We also have four scripts for running apps, including:
   - run-sketchyspice.bat, to run a simple sketching app for circuit diagrams
   - run-brainstorm.bat, to run a simple app for organizing info like post-its
   - run-scribbler.bat, to run the app from the tutorial
   - run-quill.bat, to run the Quill, a gesture design tool

--------------------------------------------------------------------------------

OVERVIEW
--------

Software support for making effective pen-based applications is currently
rudimentary. To facilitate the creation of such applications, we have
developed SATIN, a Java-based toolkit designed to support the creation of
applications that leverage the informal nature of pens. This support includes:

   o a scenegraph for manipulating and rendering objects 
   o support for zooming and rotating objects 
   o switching between multiple views of an object 
   o integration of pen input with interpreters 
   o libraries for manipulating ink strokes 
   o widgets optimized for pens 
   o and compatibility with Java's Swing toolkit 

Our Javadoc for the classes is available at:
   http://guir.cs.berkeley.edu/projects/javadoc/index-satin.html

--------------------------------------------------------------------------------

USING SATIN
-----------

To use SATIN, you'll need to set your CLASSPATH variable to point
to the satin jar file. 

   - WinNT and Window2000
     Go to "Control Panel -> System"
     Find the tab for "Environment Variables"
     Add a CLASSPATH user variable and point to the _absolute_ directory
        location of the jar file.

When developing apps, if you decide to load up a file into Rubine's Recognizer
(or if you are using RubineInterpreter), then you'll need to have the data/
directory be in the same directory you start running in. In other words, SATIN
by default looks in the folder named "./data/interpreters" to find those data
files.

--------------------------------------------------------------------------------

DOCUMENTATION AND SUPPORT
-------------------------

Here are some URLs to help out:

   SATIN Project Home Page
   - http://guir.cs.berkeley.edu/projects/satin/tutorial

   SATIN Application Programming Interfaces
   - http://guir.cs.berkeley.edu/projects/javadoc/index-satin.html

   satin-dev mailing list
   - http://guir.cs.berkeley.edu/projects/satin/support.html

--------------------------------------------------------------------------------

DENIM
-----

If you are looking for DENIM, the sketch-based web site design tool, it is at:
   http://guir.cs.berkeley.edu/projects/denim

DENIM and SATIN will be released at different intervals. Although DENIM
uses SATIN as its base, we advise you not to mix the two distributions,
as they may be out of sync.

--------------------------------------------------------------------------------

DEVELOPERS / COMMENTS / BUGS

Please send comments, bugs, and so on to
   satin-dev@cs.berkeley.edu

If you are a developer, you can also join this mailing list
by sending email to:

   majordomo@bamboo-cay.cs.berkeley.edu

with the following in the body of the email message

   subscribe satin-dev

--------------------------------------------------------------------------------

This package also uses our shared libraries, GUIRLib v1.5
   http://guir.berkeley.edu/projects/guirlib

Java source and class files written by Group for User Interface Research,
UC Berkeley. Please see the copyright in file copyright.txt