File	Date	Author	Commit
cmake-modules	2010-09-13	Jakob Leben	[e6351f] cmake: provide Kate development files if kdesdk...
kate	2010-09-18	Jakob Leben	[43eff1] Do not assume libkateinterfaces.so.4 location.
share	2010-11-04	Jakob Leben	[323569] Enhance SuperCollider menu, add toolbar
src	2010-11-04	Jakob Leben	[323569] Enhance SuperCollider menu, add toolbar
CMakeLists.txt	2010-11-03	Jakob Leben	[37ac5f] Use QtWebKit instead of KHTML + implement text ...
INSTALL	2010-08-26	Jakob Leben	[df5818] INSTALL and README update
LICENSE	2010-05-11	Jakob Leben	[5c5900] changes from 0.9.1 to 0.9.2
NEWS	2010-09-05	Jakob Leben	[19cb09] NEWS update
README	2010-09-05	Jakob Leben	[c25b02] allow to set more then one help directory

Read Me

********************************************************************************
SCATE CONFIGURATION
********************************************************************************

After you enable the Scate plugin in Kate's configuration window, you will be
able to access the Scate configuration page in the same window.

These are the configuration options:

- Sclang Command:
    The command to execute to start SuperCollider intepreter. If empty, the
    command "sclang" will be executed.

- Runtime Data Directory:
    The directory for SuperCollider's runtime data.

- Help File Directories:
    One or more directories where Scate will search for SuperCollider help
    files.

- SwingOSC Java Program:
    The full path to SwingOSC java program.

- Start Interpreter With Plugin:
    This option controls whether SuperCollider intepreter is started immediately
    after the Scate plugin is.


********************************************************************************
SCATE USAGE
********************************************************************************

--------------------------------------------------------------------------------
USER INTERFACE
--------------------------------------------------------------------------------

Enabling the Scate plugin will add the "SuperCollider" menu to Kate's main menu
bar with options to start or stop the interpreter, sound server, SwingOSC
server, and more.

Scate will add two tabs to Kate's bottom tool area:

- SC Output: opens the window where the interpreter's output will be printed and
  code can be executed.

- SC Help: opens the window where you can browse SC help files.

You can move these tabs to another tool area via the menu that pops up when
you right-click on them.

--------------------------------------------------------------------------------
CODE EXECUTION
--------------------------------------------------------------------------------

When the interpreter is running, you can execute code in two ways:

1. Below the interpreter output area there is a command line where you can
simply type in SuperCollider commands and execute them by pressing "Enter". You
can access previously executed commands with "Up" and "Down" keys.

2. You can let the interpreter evaluate SuperCollider code within a Kate
document by selecting it and invoking Ctrl+E shortcut or invoking respective
action in SuperCollider menu. If no text is selected entire current line is
evaluated.