convert README to textile

This commit is contained in:
rob 2008-12-22 01:50:44 +00:00
parent a427cec5c5
commit a3c8a7be24
4 changed files with 130 additions and 79 deletions

69
README
View File

@ -1,69 +0,0 @@
**************************************************************************
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.
Binary: http://www.trapdoor1.net/sc3/sc3ctrl.tar.gz
(as yet untested on anything other than 10.5)
Source code: http://github.com/rfwatson/sc3ctrl
Binary 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)

75
README.textile Normal file
View File

@ -0,0 +1,75 @@
h1. "sc3ctrl":http://github.com/rfwatson/sc3ctrl
A command line utility which uses OpenSoundControl to control
"SuperCollider3.app":http://supercollider.sourceforge.net in OSX.
Consists of a small CoreFoundation bundle written in Objective-C and a
single SuperCollider class.
Binary download: http://www.trapdoor1.net/sc3/sc3ctrl.tar.gz
(as yet untested on anything other than 10.5)
h2. Binary Installation
# Drag the bundle into a suitable location on your machine
(e.g. @/Application/Utilities/@)
# @cd /Application/Utilities/sc3ctrl/@
# @sudo ./install.rb@
# Start SuperCollider.app
h2. Command line usage
* @sc3ctrl -x@ <br/>
Execute the SC code in environment variable @SC_INTERPRET_TEXT@
* @sc3ctrl -x VARIABLE_NAME@ <br/>
Execute the SC code in environment variable @VARIABLE_NAME@
* @sc3ctrl -d classname@ <br/>
Open help file for @classname@
* @sc3ctrl -j classname@ <br/>
Open class definition for @classname@
* @sc3ctrl -y methodname@ <br/>
Examine implementations of @methodname@
* @sc3ctrl -Y methodname@ <br/>
Examine references to @methodname@
* @sc3ctrl -s@ <br/>
Stop server (@CMD-PERIOD@)
* @sc3ctrl -c@ <br/>
Clear post window
* @sc3ctrl -p@ <br/>
Post window to front
* @sc3ctrl -k@ <br/>
Recompile class library (requires recent build)
h2. Contact me
Via "github":http://github.com/rfwatson
**************************************************************************
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
**************************************************************************

View File

@ -439,6 +439,10 @@
567168030EFEF2A50047EA2B /* PBXTextBookmark */ = 567168030EFEF2A50047EA2B /* PBXTextBookmark */;
567168050EFEF4F20047EA2B /* PBXTextBookmark */ = 567168050EFEF4F20047EA2B /* PBXTextBookmark */;
567168060EFEF4F20047EA2B /* PBXTextBookmark */ = 567168060EFEF4F20047EA2B /* PBXTextBookmark */;
567168080EFF06BC0047EA2B /* PBXTextBookmark */ = 567168080EFF06BC0047EA2B /* PBXTextBookmark */;
567168090EFF06BC0047EA2B /* PBXTextBookmark */ = 567168090EFF06BC0047EA2B /* PBXTextBookmark */;
5671680A0EFF06BC0047EA2B /* PBXTextBookmark */ = 5671680A0EFF06BC0047EA2B /* PBXTextBookmark */;
5671680B0EFF06BC0047EA2B /* PBXTextBookmark */ = 5671680B0EFF06BC0047EA2B /* PBXTextBookmark */;
};
sourceControlManager = 567161F90EFD3E860047EA2B /* Source Control */;
userBuildSettings = {
@ -2729,8 +2733,8 @@
567167630EFECFD80047EA2B /* SC3Controller.sc */ = {
uiCtxt = {
sepNavIntBoundsRect = "{{0, 0}, {1412, 2240}}";
sepNavSelRange = "{3479, 0}";
sepNavVisRange = "{2659, 820}";
sepNavSelRange = "{3474, 0}";
sepNavVisRange = "{0, 847}";
};
};
567167660EFECFE10047EA2B /* PBXTextBookmark */ = {
@ -3868,6 +3872,46 @@
vrLen = 420;
vrLoc = 0;
};
567168080EFF06BC0047EA2B /* PBXTextBookmark */ = {
isa = PBXTextBookmark;
fRef = 5671676A0EFEDC650047EA2B /* README */;
name = "README: 35";
rLen = 0;
rLoc = 1240;
rType = 0;
vrLen = 919;
vrLoc = 829;
};
567168090EFF06BC0047EA2B /* PBXTextBookmark */ = {
isa = PBXTextBookmark;
fRef = 5671676A0EFEDC650047EA2B /* README */;
name = "README: 35";
rLen = 0;
rLoc = 1240;
rType = 0;
vrLen = 919;
vrLoc = 829;
};
5671680A0EFF06BC0047EA2B /* PBXTextBookmark */ = {
isa = PBXTextBookmark;
fRef = 567167630EFECFD80047EA2B /* SC3Controller.sc */;
name = "SC3Controller.sc: 140";
rLen = 0;
rLoc = 3474;
rType = 0;
vrLen = 847;
vrLoc = 0;
};
5671680B0EFF06BC0047EA2B /* PBXTextBookmark */ = {
isa = PBXTextBookmark;
fRef = 567167760EFEDCB50047EA2B /* install.rb */;
name = "install.rb: 14";
rLen = 0;
rLoc = 400;
rType = 0;
vrLen = 420;
vrLoc = 0;
};
8DD76F960486AA7600D96B5E /* sc3ctrl */ = {
activeExec = 0;
executables = (

View File

@ -216,7 +216,7 @@
<key>_historyCapacity</key>
<integer>0</integer>
<key>bookmark</key>
<string>567168060EFEF4F20047EA2B</string>
<string>5671680B0EFF06BC0047EA2B</string>
<key>history</key>
<array>
<string>567167AA0EFEE3560047EA2B</string>
@ -272,6 +272,8 @@
<key>Layout</key>
<array>
<dict>
<key>BecomeActive</key>
<true/>
<key>ContentConfiguration</key>
<dict>
<key>PBXBottomSmartGroupGIDs</key>
@ -324,7 +326,7 @@
<key>PBXSmartGroupTreeModuleOutlineStateSelectionKey</key>
<array>
<array>
<integer>9</integer>
<integer>1</integer>
<integer>0</integer>
</array>
</array>
@ -357,14 +359,12 @@
<key>Dock</key>
<array>
<dict>
<key>BecomeActive</key>
<true/>
<key>ContentConfiguration</key>
<dict>
<key>PBXProjectModuleGUID</key>
<string>567162000EFD3EA50047EA2B</string>
<key>PBXProjectModuleLabel</key>
<string>README</string>
<string>SC3Controller.sc</string>
<key>PBXSplitModuleInNavigatorKey</key>
<dict>
<key>Split0</key>
@ -372,11 +372,11 @@
<key>PBXProjectModuleGUID</key>
<string>567162010EFD3EA50047EA2B</string>
<key>PBXProjectModuleLabel</key>
<string>README</string>
<string>SC3Controller.sc</string>
<key>_historyCapacity</key>
<integer>0</integer>
<key>bookmark</key>
<string>567168050EFEF4F20047EA2B</string>
<string>5671680A0EFF06BC0047EA2B</string>
<key>history</key>
<array>
<string>567164430EFE8E370047EA2B</string>
@ -388,8 +388,8 @@
<string>567167960EFEE0EC0047EA2B</string>
<string>567167D00EFEEA010047EA2B</string>
<string>567167F50EFEEC780047EA2B</string>
<string>567168080EFF06BC0047EA2B</string>
<string>567167FE0EFEF2A50047EA2B</string>
<string>567167FF0EFEF2A50047EA2B</string>
</array>
<key>prevStack</key>
<array>
@ -483,6 +483,7 @@
<string>567167F60EFEEC780047EA2B</string>
<string>567168000EFEF2A50047EA2B</string>
<string>567168010EFEF2A50047EA2B</string>
<string>567168090EFF06BC0047EA2B</string>
</array>
</dict>
<key>SplitCount</key>