notes/INSTALL

   1 ChucK : Build Instructions
   2
   3 version: 1.2.x.x (dracula)
   4
   5 ---
   6
   7 ChucK home:
   8     http://chuck.cs.princeton.edu/
   9
  10 Got questions?
  11     http://chuck.cs.princeton.edu/community.html
  12
  13 email us:
  14     gewang@cs.princeton.edu
  15
  16 online version of this document:
  17     http://chuck.cs.princeton.edu/doc/build/
  18
  19 ---
  20
  21 If you are using the executable, you only need to put chuck (osx) or
  22 chuck.exe (win32) in your path.
  23
  24 On MacOS X (using Terminal): go to the bin/ directory and type:
  25
  26     sudo cp chuck /usr/bin/
  27     (enter your password when prompted)
  28
  29     sudo chmod 755 /usr/bin/chuck
  30     (now you can run chuck from any directory using Terminal)
  31
  32 On win32: put bin\chuck.exe in c:\windows\system32\
  33
  34 At this point, you should be able to invoke 'chuck' from either Terminal
  35 (in OSX) or 'cmd' under windowsm, from any directory:
  36
  37     > chuck
  38     [chuck]: no input files... (try --help)
  39
  40 (this is the correct output, since we didn't specify the files to run)
  41
  42 If that is the case, you can skip the rest of this document.
  43
  44 ---
  45
  46 We tried to make ChucK as easy as possible to build and re-use. All
  47 sources files - headers source for compiler, vm, and audio engine - are
  48 in the same directory (they run in the same address space anyway). Platforms
  49 differences are abstracted to the lowest level (in part thanks to Gary
  50 Scavone). None of the compiler/vm has any OS-depedent code. To build
  51 chuck from the source (from scratch):
  52
  53 ---
  54
  55 1. Go to the src/ directory (replace chuck-x.x.x.x with the actual
  56 directory name):
  57
  58    %> cd chuck-x.x.x.x/src/
  59
  60 ---
  61
  62 2. If you type 'make' here, you should get the following message:
  63
  64    %> make
  65    [chuck build]: please use one of the following configurations:
  66        make osx-ppc, make osx-intel, make win32,
  67        make linux-oss, make linux-alsa, or make linux-jack
  68
  69 Now, type the command corresponding to your platform...
  70
  71 for example, for MacOS X (PowerPC):
  72
  73    %> make osx-ppc
  74
  75 or for MacOS X (Intel):
  76
  77    %> make osx-intel
  78
  79 etc...
  80
  81 ---
  82
  83 3. If you like to install chuck (cp into /usr/bin by default). if you
  84 don't like the destination, simply edit the makefile under 'install', or
  85 skip this step altogether. (we recommend putting it somewhere in your
  86 path, it makes on-the-fly programming easier)
  87
  88    # (optional: edit the makefile first)
  89    %> make install
  90
  91 ---
  92
  93 4. If you haven't gotten any egregous error messages up to this point,
  94 then you should be done! There should be a 'chuck' executable in the
  95 current directory. For a quick sanity check, execute the following (use
  96 './chuck' if chuck is not in your path), and see if you get the same output:
  97
  98    %> chuck
  99    [chuck]: no input files...
 100
 101 (if you do get error messages during compilation, or you run into some
 102 other problem - please let us know and we will do our best to provide
 103 support)
 104
 105 ---
 106
 107 5. You are ready to ChucK. If this is your first time programming in
 108 ChucK, you may want to look at the documentation, or take the ChucK
 109 Tutorial (in doc/ and online http://chuck.cs.princeton.edu/doc/). ThanK
 110 you very much. Go forth and ChucK - email us for support or to make a
 111 suggestion or to call us idiots.
 112
 113 Ge + Perry