README_WINDOWS.txt

   1 ------------------------------------------------------------------------\r
   2 Supercollider 3.5 for Windows\r
   3 ------------------------------------------------------------------------\r
   4 \r
   5 This is the Windows version of James McCartney's SuperCollider synthesis \r
   6 engine (scsynth) and programming language (sclang). \r
   7 Supercollider's main homepage is at\r
   8    http://supercollider.sourceforge.net/\r
   9 \r
  10 There is a lot of useful information and tutorials in the SuperCollider\r
  11 documentation which you can access online at\r
  12     http://doc.sccode.org\r
  13 \r
  14 To get further information on SuperCollider usage or development, you\r
  15 should subscribe to the mailing lists:\r
  16    http://www.beast.bham.ac.uk/research/sc_mailing_lists.shtml\r
  17 \r
  18 ------------------------------------------------------------------------\r
  19 System Requirements\r
  20 ------------------------------------------------------------------------\r
  21 \r
  22 * Windows 7/Vista/XP/2000\r
  23 * (Optional) Gedit text editor\r
  24 \r
  25 The preferred way to use SuperCollider on Windows is in combination\r
  26 with the Gedit text editor. SuperCollider for Windows comes with\r
  27 Sced - a plugin for Gedit that provides syntax highlighting for\r
  28 SuperCollider code, and allows easy interaction with SuperCollider\r
  29 from within the editor.\r
  30 \r
  31 NOTE: There is currently an issue on Windows XP that the default (local)\r
  32 synthesis server can not be started from within Gedit. To work around\r
  33 that, either use the internal server, or start up a server from command\r
  34 line and connect to it from Gedit. This issue is not present on Windows 7.\r
  35 \r
  36 Most common sound cards will work fine - the sound card should be one\r
  37 that is supported by PortAudio (http://www.portaudio.com/). If you have\r
  38 issues with latency, consult http://www.portaudio.com/docs/latency.html\r
  39 for advice on how to tune your operating system to achieve the best results\r
  40 (in short: use ASIO drivers wherever possible).\r
  41 \r
  42 ------------------------------------------------------------------------\r
  43 Installation\r
  44 ------------------------------------------------------------------------\r
  45 \r
  46 If you intend to use SuperCollider in combination with Gedit, please\r
  47 install the latest Gedit version for Windows prior to installing\r
  48 SuperCollider. You can download Gedit from this address:\r
  49 \r
  50 http://ftp.gnome.org/pub/GNOME/binaries/win32/gedit/2.30/gedit-setup-2.30.1-1.exe\r
  51 \r
  52 The SuperCollider installer will ask you whether you also want to install\r
  53 Sced - the SuperCollider plugin for Gedit. If you decide so, you will be\r
  54 asked to specify the directory where you have installed Gedit (the installer\r
  55 will probably guess that automatically).\r
  56 \r
  57 After installation, you can use SuperCollider in two ways:\r
  58 A) From within Gedit text editor (if you chose to install Sced).\r
  59 B) Via the command-line.\r
  60 \r
  61 The two ways are described below.\r
  62 \r
  63 ------------------------------------------------------------------------\r
  64 Using SuperCollider with Gedit text editor\r
  65 ------------------------------------------------------------------------\r
  66 \r
  67 This is the preferred and more powerful way.\r
  68 \r
  69 1. Start up Gedit, and first enable the Sced plugin in the preferences\r
  70 dialog: "Edit > Preferences > Plugins". You only need to do this step\r
  71 once. After that the plugin will stay enabled whenever you restart Gedit.\r
  72 \r
  73 2. To start up SuperCollider, click on the menu entry\r
  74 "Tools > SuperCollider Mode". This will start the interpreter and add\r
  75 a new menu named "SuperCollider", which gives you many options for\r
  76 further interaction with the interpreter and the sound synthesis server.\r
  77 \r
  78 ------------------------------------------------------------------------\r
  79 Using SuperCollider in command line mode\r
  80 ------------------------------------------------------------------------\r
  81 \r
  82 1. Open a Windows command line window (the cmd.exe program).\r
  83 \r
  84 2. Navigate to the SuperCollider installation folder.\r
  85 \r
  86 3. Start up the sclang.exe program, to enter the SuperCollider\r
  87 command line.\r
  88 \r
  89 4. You can now type SuperCollider code and evaluate it by pressing\r
  90 the Enter (Return) key. You can browse the previous commands using\r
  91 the up and down arrow keys.\r
  92 \r
  93 5. These are the handy keyboard shortcuts:\r
  94 - Ctrl+T : equivalent to CmdPeriod.run\r
  95 - Ctrl+X : to recompile the class library\r
  96 - Ctrl+D: to quit the SuperCollider command line\r
  97 \r
  98 ------------------------------------------------------------------------\r
  99 Paths and files you may want to be aware of\r
 100 ------------------------------------------------------------------------\r
 101 \r
 102 - $USER_HOME$\SuperCollider\startup.scd : user startup file\r
 103 \r
 104 - $USER_HOME$\SuperCollider\Extensions : user extension folder for classes,\r
 105 plugins and help files\r
 106 \r
 107 ------------------------------------------------------------------------\r
 108 Outro\r
 109 ------------------------------------------------------------------------\r
 110 \r
 111 Thanks to James McCartney, for making this great piece of audio\r
 112 software publically and freely available.\r