sc3ctrl/README

67 lines
1.9 KiB
Plaintext

**************************************************************************
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
**************************************************************************
Introduction
============
sc3ctrl is a command line utility which uses OpenSoundControl to control
SuperCollider3.app in OSX.
Consists of a small CoreFoundation bundle written in Objective-C and a
single SuperCollider class.
Source code: http://github.com/rfwatson/sc3ctrl
Installation
============
1) Drag the bundle into a suitable location on your machine
(e.g. /Application/Utilities/)
2) cd /Application/Utilities/sc3ctrl/
3) sudo install.rb
4) Start SuperCollider.app
Usage
=====
sc3ctrl -x Execute the SC code in environment variable SC_INTERPRET_TEXT
sc3ctrl -x VARIABLE_NAME Execute the SC code in environment variable VARIABLE_NAME
sc3ctrl -d classname Open help file for classname
sc3ctrl -j classname Open class definition for classname
sc3ctrl -y methodname Examine implementations of methodname
sc3ctrl -Y methodname Examine references to methodname
sc3ctrl -s Stop server (CMD-PERIOD)
sc3ctrl -c Clear post window
sc3ctrl -p Post window to front
sc3ctrl -k Recompile class library (requires recent build)