update README
This commit is contained in:
Rob Watson
parent
d8fc01f4de
commit
ed208d9fca
75
README
75
README
|
|
@ -1,75 +0,0 @@
|
||||||
SuperCollider/TextMate bundle
|
|
||||||
=============================
|
|
||||||
|
|
||||||
Contained is a SuperCollider bundle for TextMate. The bundle utilizes OSX's AppleScript to automate basic SC functionality, such as executing code, stopping playback and recompiling the class library, all using standard keyboard shortcuts, and all from within TextMate.
|
|
||||||
|
|
||||||
This bundle is still in development/beta phase, please report any problems or comments.
|
|
||||||
|
|
||||||
|
|
||||||
Prerequisites
|
|
||||||
=============
|
|
||||||
|
|
||||||
SuperCollider - a recent build: http://supercollider.wesleyan.edu/
|
|
||||||
TextMate - http://macromates.com/
|
|
||||||
Git - http://code.google.com/p/git-osx-installer/ or http://git.or.cz/
|
|
||||||
|
|
||||||
|
|
||||||
Installation
|
|
||||||
============
|
|
||||||
|
|
||||||
cd ~/Library/Application\ Support/TextMate/Bundles/
|
|
||||||
git clone git://github.com/rfwatson/textmate-supercollider.git SuperCollider.tmbundle
|
|
||||||
defaults write /Applications/SuperCollider/SuperCollider.app/Contents/Info NSAppleScriptEnabled -bool YES
|
|
||||||
|
|
||||||
The final command enables basic AppleScript functionality in SuperCollider, and is required.
|
|
||||||
You may need to adapt the above commands to match your paths to TextMate Bundles/, and SuperCollider.app.
|
|
||||||
|
|
||||||
|
|
||||||
Usage
|
|
||||||
=====
|
|
||||||
|
|
||||||
1) Launch TextMate. Open a .sc file. Ensure SuperCollider bundle is selected.
|
|
||||||
|
|
||||||
2) Launch SuperCollider.app.
|
|
||||||
|
|
||||||
The following key commands should work in TextMate:
|
|
||||||
|
|
||||||
ENTER - execute line, or selection if available
|
|
||||||
CTRL-. - stop playback
|
|
||||||
CMD-K - recompile class library
|
|
||||||
CMD-D - open help
|
|
||||||
SHIFT-CMD-D - open help browser
|
|
||||||
CMD-? - post window to front
|
|
||||||
SHIFT-CMD-C - clear post window
|
|
||||||
CTRL-ALT-CMD-S - switch to SuperCollider mode (should be automatic with .sc files)
|
|
||||||
|
|
||||||
|
|
||||||
LIMITATIONS
|
|
||||||
===========
|
|
||||||
|
|
||||||
Selecting a word and searching the help file, or class definition, for it is not yet implemented. For the meantime, I find the quickest way to access these files is to copy them somewhere in your home directory, and then use Spotlight to search for them (shortcut: CMD-spacebar).
|
|
||||||
|
|
||||||
TextMate does not handle .rtf files, so old source files may need copy-and-pasting into TextMate, or otherwise converting to plain text.
|
|
||||||
|
|
||||||
|
|
||||||
CREDITS
|
|
||||||
=======
|
|
||||||
|
|
||||||
Jacob Rus's menu_click functions: http://pastie.org/14358
|
|
||||||
|
|
||||||
|
|
||||||
TODO
|
|
||||||
====
|
|
||||||
|
|
||||||
- Tidy up syntax highlighting, is somewhat messy at the moment
|
|
||||||
- Enable searching of help files/class defs from within TextMate
|
|
||||||
- Clean up AppleScript/menu_click function
|
|
||||||
- Some strange menu rendering problems when switching between apps??
|
|
||||||
- ??????
|
|
||||||
|
|
||||||
|
|
||||||
CONTACT
|
|
||||||
=======
|
|
||||||
|
|
||||||
Contact me via github:
|
|
||||||
http://github.com/rfwatson
|
|
||||||
98
README.html
98
README.html
|
|
@ -1,98 +0,0 @@
|
||||||
<h1><a href="http://github.com/rfwatson/textmate-supercollider">textmate-supercollider</a></h1>
|
|
||||||
|
|
||||||
|
|
||||||
<p>A <a href="http://supercollider.sourceforge.net">SuperCollider</a> bundle for <a href="http://www.macromates.com">TextMate</a>.</p>
|
|
||||||
|
|
||||||
|
|
||||||
<h2>Key controls</h2>
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><code>ENTER</code><br/>Execute current selection/line</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><code>CTRL-PERIOD</code><br/>
|
|
||||||
Stop server</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><code>CMD-k</code><br/>
|
|
||||||
recompile class library</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><code>CMD-d</code><br/>
|
|
||||||
Help</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><code>CMD-j</code><br/>
|
|
||||||
Open class definition</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><code>CMD-y</code><br/>
|
|
||||||
Implementations of</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><code>CMD-Y</code><br/>
|
|
||||||
References to</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><code>CMD-?</code><br/>
|
|
||||||
Post window to front</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><code>CMD-SHIFT-C</code><br/>
|
|
||||||
Clear post window</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><code>CMD-ALT-CTRL-S</code><br/>
|
|
||||||
Switch to SuperCollider mode</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
<p><br/>
|
|
||||||
<strong>plus</strong> various snippets – check the bundle.</p>
|
|
||||||
|
|
||||||
|
|
||||||
<h2>Installation</h2>
|
|
||||||
|
|
||||||
|
|
||||||
<ol>
|
|
||||||
<li>Double click on SuperCollider.tmbundle.</li>
|
|
||||||
<li>Copy TextMate.sc to SuperCollider Extensions directory and relaunch SC.</li>
|
|
||||||
<li>With .sc document open in TextMate, commands should now work as long as both SC and TM are open..</li>
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
<h2>Notes</h2>
|
|
||||||
|
|
||||||
|
|
||||||
<p>I’ve extracted the underlying code to allow control of SC.app from any command line application.<br/><a href="http://github.com/rfwatson/sc3ctrl">sc3ctrl on github</a></p>
|
|
||||||
|
|
||||||
|
|
||||||
<h2>Disclaimer</h2>
|
|
||||||
|
|
||||||
|
|
||||||
<p>This is a new implementation and still as yet not properly tested<br/></p>
|
|
||||||
|
|
||||||
|
|
||||||
<h2>Contact me</h2>
|
|
||||||
|
|
||||||
|
|
||||||
<p>Via <a href="http://github.com/rwatson">github</a></p>
|
|
||||||
|
|
@ -4,12 +4,34 @@ A "SuperCollider":http://supercollider.sourceforge.net bundle for "TextMate":htt
|
||||||
|
|
||||||
!http://farm4.static.flickr.com/3214/3005708965_4b6122cc66.jpg!:http://farm4.static.flickr.com/3214/3005708965_4b6122cc66_b.jpg
|
!http://farm4.static.flickr.com/3214/3005708965_4b6122cc66.jpg!:http://farm4.static.flickr.com/3214/3005708965_4b6122cc66_b.jpg
|
||||||
|
|
||||||
"Download most recent tarball":http://github.com/rfwatson/textmate-supercollider/tarball/master
|
|
||||||
|
|
||||||
h2. Requirements
|
h2. Requirements
|
||||||
|
|
||||||
A "recent build":http://sourceforge.net/projects/supercollider of SC (>= 3.3 alpha)
|
A "recent build":http://sourceforge.net/projects/supercollider of SC (>= 3.3 alpha)
|
||||||
|
|
||||||
|
h2. Installation
|
||||||
|
|
||||||
|
h3. With git
|
||||||
|
|
||||||
|
* @mkdir -p ~/Library/Application\ Support/TextMate/Bundles@
|
||||||
|
* @cd ~/Library/Application\ Support/TextMate/Bundles@
|
||||||
|
* @git clone git://github.com/rfwatson/supercollider-tmbundle.git "SuperCollider.tmbundle"@
|
||||||
|
* @osascript -e 'tell app "TextMate" to reload bundles'@
|
||||||
|
|
||||||
|
h3. Without git
|
||||||
|
|
||||||
|
* @mkdir -p ~/Library/Application\ Support/TextMate/Bundles@
|
||||||
|
* @cd ~/Library/Application\ Support/TextMate/Bundles@
|
||||||
|
* @wget http://github.com/rfwatson/supercollider-tmbundle/tarball/master@
|
||||||
|
* @tar zxf rfwatson-supercollider-tmbundle*.tar.gz@
|
||||||
|
* @rm rfwatson-supercollider-tmbundle*.tar.gz@
|
||||||
|
* @mv rfwatson-supercollider-tmbundle* SuperCollider.tmbundle@
|
||||||
|
* @osascript -e 'tell app "TextMate" to reload bundles'@
|
||||||
|
|
||||||
|
h3. After installing
|
||||||
|
|
||||||
|
* Open TextMate and select 'SuperCollider' bundle
|
||||||
|
* Press CMD-SHIFT-F1 to complete installation.
|
||||||
|
|
||||||
h2. Key controls
|
h2. Key controls
|
||||||
|
|
||||||
* @ENTER@<br/>Execute current selection/line
|
* @ENTER@<br/>Execute current selection/line
|
||||||
|
|
@ -44,24 +66,18 @@ Switch to SuperCollider mode
|
||||||
<br/>
|
<br/>
|
||||||
*plus* various snippets - check the bundle.
|
*plus* various snippets - check the bundle.
|
||||||
|
|
||||||
|
h2. Limitations
|
||||||
|
|
||||||
h2. Installation
|
TextMate does not handle .rtf documents. So .rtf files will have to be copy-and-pasted into .sc text files. This is not a problem for classes.
|
||||||
|
|
||||||
# Double click on SuperCollider.tmbundle.
|
CMD-period cannot be programmed in TextMate, so to stop audio output use CTRL-period instead
|
||||||
# Copy TextMate.sc to SuperCollider class load path, eg @~/Application\ Support/SuperCollider/Extensions/@. Relaunch SC.
|
|
||||||
# With .sc document open in TextMate, commands should now work as long as both SC and TM are open..
|
|
||||||
|
|
||||||
|
Class lib can only currently be recompiled from within TextMate (CMD-K) if there's been no previous error compiling it. Recompile from within SC in that case
|
||||||
|
|
||||||
h2. Notes
|
h2. Notes
|
||||||
|
|
||||||
I've extracted the underlying code to allow control of SC.app from any command line application.<br/>"sc3ctrl on github":http://github.com/rfwatson/sc3ctrl
|
I've extracted the underlying code to allow control of SC.app from any command line application.<br/>"sc3ctrl on github":http://github.com/rfwatson/sc3ctrl
|
||||||
|
|
||||||
|
|
||||||
h2. Disclaimer
|
|
||||||
|
|
||||||
This is a new implementation and still as yet not properly tested<br/>
|
|
||||||
|
|
||||||
|
|
||||||
h2. Contact me
|
h2. Contact me
|
||||||
|
|
||||||
Via "github":http://github.com/rfwatson
|
Via "github":http://github.com/rfwatson
|
||||||
Loading…
Reference in New Issue