editors/sced/README

   1
   2     This is Sced, a SuperCollider interaction plugin for gedit.
   3
   4     Sced aims to simplify SuperCollider experience on Linux systems
   5     as far as possible.
   6
   7 Installation
   8 ============
   9
  10 To install sced via cmake, configure the build directory with
  11 `cmake -DSC_ED=ON'
  12
  13 This will install sced for the most recent version of gedit available on your
  14 platform (version 3 on Linux and Mac OS X, and version 2 on Windows).
  15
  16 If you specifically want to install sced for gedit version 2 instead of 3,
  17 configure the build directory with
  18 'cmake -DSC_ED=2'
  19
  20 When installing into /usr/local (which is the default), gedit won't find
  21 the plugin since it only looks in /usr. To fix this, simply symlink
  22 the plugin-files to ~/.local/share/gedit/plugins/:
  23
  24   $ mkdir -p ~/.local/share/gedit/plugins
  25   $ cd ~/.local/share/gedit/plugins
  26   $ ln -sf /usr/local/lib/gedit/plugins/supercollider.plugin .
  27   $ ln -sf /usr/local/lib/gedit/plugins/supercollider.py .
  28
  29 OSX
  30 ===
  31
  32 Sced works fine for gedit3 on OSX, if you follow these instructions:
  33
  34 Copy or symlink supercollider.plugin and supercollider.py from
  35 <build>/Install/lib/gedit/plugins/ into ~/.local/share/gedit/plugins/
  36
  37 Place wrapper-scripts for sclang and scsynth into /usr/local/bin.
  38 For sclang:
  39
  40   #!/bin/sh
  41   cd /full/path/to/SuperCollider.app/Contents/Resources
  42   exec ./sclang $*
  43
  44 And for scsynth:
  45
  46   #!/bin/sh
  47   cd /full/path/to/SuperCollider.app/Contents/Resources
  48   exec ./scsynth $*
  49
  50 You need to make the scripts executable:
  51
  52   $ chmod +x sclang
  53   $ chmod +x scsynth
  54
  55 Usage
  56 =====
  57
  58 To enable sced, open gedit's preferences and go to the Plugins tab and
  59 check the SuperCollider plugin checkbox. You only need to do this once.
  60
  61 When sced is enabled, you activate it with the menu Tools>SuperCollider mode
  62
  63 The menu items describe themselves. You're going to use the Ctrl+E shortcut
  64 a lot. By default, this command evaluates the current line of code. If you
  65 select several lines, hitting Ctrl+E will evaluate them all.
  66
  67 You can also select and run a ()-block. Just place the cursor on the opening
  68 bracket and press Ctrl+E, i. e.:
  69
  70 ( // press Ctrl+E here
  71 "hello".postln;
  72 "world".postln;
  73 );
  74
  75 Sced is released under the GNU General Public License (GPL) version 3, see
  76 the file 'COPYING' for more information.