1 ## Identifying your system ##
3 We'll assume you're using either Mac OS X, or Windows, or Linux.
4 If you're running **iOS**, you'll have a much harder time (perhaps impossible,
5 perhaps not) getting this software to run on your machine, and we can't give
8 If you're using **Mac OS X**, take note of what version of the Mac OS you're
9 running. (Under the Apple Menu, select "About this Mac".)
14 * Mountain Lion (10.8)
18 Furthermore, Mac users will be in one of two subgroups:
20 * You'll have Apple's Xcode and the independent MacPorts system
21 installed. (Probably you don't. If you don't know what I'm talking about, you don't have these.)
23 If you don't have these, but want to try this route, you can read about
24 the MacPorts system at <http://www.macports.org/>.
25 This automates the building of Unix-type software on your Mac; it
26 makes it a lot easier to check for dependencies, use more-recent
27 versions of things, and so on. (Though as it happens, MacPorts only has an older version of
28 our chosen implementation of Scheme.)
30 There are also other package management systems available for the Mac, notably Homebrew and Fink. I only know a little bit about them.
32 There are instructions about how to get Xcode on the [Installing MacPorts](https://www.macports.org/install.php) page.
33 Some versions of [Xcode](http://developer.apple.com/xcode.html) are available for free on the Mac App Store.
34 Other versions are available through Apple's Developer website (some of these are free, but do require you to
35 register with Apple as an "Apple Developer", which involves clicking to accept a legal agreement with Apple).
36 I have an older version of this installed. If you download a recent version, email me and let me know how the
37 process works so I can tell others.
39 The latest version of Xcode to work with 10.5 / Leopard is 3.14; more recent versions (>= 3.2) require 10.6 / Snow Leopard.
40 3.2.6 is last version that can be downloaded for free by users of 10.6 / Snow Leopard. (But if they pay, they can use up to Xcode 4.2.)
41 Xcode 4.1 was free to all users of 10.7 / Lion. Is Xcode 4.6.x still available for free? Are Xcode 5.x and/or 6.x available for free?
44 * Or you won't have those installed. (**Most Mac users will be in this group.**)
45 Then you'll need pre-packaged (and usually pretty GUI) installers for
46 everything. These are great when they're available and kept up-to-date;
47 however sometimes those conditions aren't met.
51 If you're using **Windows**, you'll be in one of two subgroups:
53 * You'll have the Cygwin system <http://www.cygwin.com/> installed.
54 This puts a Unix-like layer on top of your Windows system,
55 and makes it easier for you to use the same software everybody
56 else will be using, without its needing as much special-for-Windows
57 treatment. However, many of you won't have this installed.
59 * You won't have Cygwin installed. (**Most Windows users will be in this group.**)
60 You might in theory have a different group of compilers installed
61 (MinGW, or Microsoft Visual C++) but we'll assume that the overwhelming
62 majority of users in this group don't have access to a compiler and
63 need pre-packaged installers for everything.
66 If you're using **Linux**, you could be using any one of numerous packaging
69 * We'll give examples using the packaging system shared by Debian and Ubuntu,
70 and we'll assume that those of you using different packaging systems will know
71 how to make the relevant substitutions.
74 **For everyone**, a general item to take note of is what "processor architecture" your machine is running. Three of the possibilities are:
76 * One of Intel's i386, i486, i586, i686 architectures. These are collectively known as "x86" or "IA-32" or sometimes just "32-bit".
77 * Intel or AMD's x86\_64 architecture. This is also called "x64" or "amd64" or "IA-64" or sometimes just "64-bit". (Note that these *aren't* "x86" machines, even though "x86\_64" starts with those letters.)
78 * ARM or some other architecture. These are generally lower-powered machines, like iPads. Some of the software we're proposing *might* in principle be capable of running on such machines, but installers don't seem to be available. We'll assume you have access to an x86 or x86\_64 machine.
80 On Linux or Mac OS X, you can open a terminal and type `uname -m`. If the
81 result is "x86\_64", then you've got x64/64-bit. If it's "i386" or something
82 like that, then you've got x86/32-bit. I think that Mac OS Xs from 10.7 / Lion
83 forward have all been x86\_64-only.
86 [here is a page that can help you figure this out](http://windows.microsoft.com/en-us/windows/32-bit-and-64-bit-windows).
87 I think that most machines running Windows XP will be x86/32-bit (unless it's
88 a version of Windows with "64-bit" or "x64" in its title); machines running
89 Windows Vista or Windows 7 or Windows 8 could be running either x86/32-bit or
93 ## PLEASE REPORT PROBLEMS (AND SOLUTIONS!) ##
95 We haven't tested these instructions ourselves, and they're not explicit
96 step-by-step instructions in any case. If you encounter troubles, please email
97 to let us know so that we can amend the instructions to help others. If you
98 figure out how to fix the problem youself (and please do), please also write
99 with suggestions how we can change these instructions to make the process
100 easier and more straightforward for others.
105 **Scheme** is one of two or three major dialects of *Lisp*, which is a large family
106 of programming languages. The other dialects are called "Common Lisp" and "Clojure".
107 Scheme is the more clean and minimalist dialect, and is what's mostly used in
110 * In your web browser:
112 There is a (slow, bare-bones) version of Scheme available for online use at <http://tryscheme.sourceforge.net/>.
114 Scheme itself has umpteen different "implementations", which share most of
115 their fundamentals, but have slightly different extensions and interact with
116 the operating system differently. One major implementation is called [Racket](http://racket-lang.org),
117 and that is what we recommend you use. (A few years back they were called PLT Scheme, but then
118 they changed their name to Racket.)
119 If you're already using or comfortable with
120 another Scheme implementation, though, there's no compelling reason to switch.
123 Another good Scheme implementation is [Chicken](http://www.call-cc.org). For our purposes, this is in some respects
124 superior to Racket, and in other respects inferior. If you have any issues with installing or using Racket, you could
125 try this out instead. You might even want to install both.
128 Racket doesn't have R7RS-small, and won't anytime soon.
129 Other R7RS-friendly: [Gauche](http://practical-scheme.net/gauche), [Chibi](https://code.google.com/p/chibi-scheme).
132 Racket and Chicken stand to Scheme in something like the relation Firefox stands to HTML. They are two programs (or platforms) among others for working with the Scheme language; and many of those programs (or web browsers) permit different extensions, have small variations, and so on.
134 Racket has several components. The two most visible components for us are a command-line interpreter named "racket" and a teaching-friendly editor/front-end named "DrRacket". You will probably be working primarily or wholly in the latter.
135 <!-- "racket" used to be mzscheme, "DrRacket" used to be DrScheme -->
137 The current version of Racket is 6.1.1 (released November 2014).
139 * **To install in Windows**
141 Go to <http://racket-lang.org/download/>. Download and install the "Windows x64" version. (Or the "Windows x86" verson if you have an older, 32-bit system.)
143 * **To install on Mac without MacPorts**
145 Go to <http://racket-lang.org/download/>. Download and install the option for your system, most likely "Macintosh
146 OS X (Intel 64-bit)".
148 After you copy the files from the Installation disk to your /Applications folder, I think it's helpful to do these additional steps. In a Terminal, type:
150 sudo ln -s /Applications/Racket*/DrRacket.app /Applications/
151 sudo ln -s /Applications/Racket*/bin/racket /usr/bin/
153 Then you can launch Racket either by double-clicking the DrRacket icon in
154 your Applications folder (this gives you the GUI interface); or by typing
155 `racket` in a Terminal (this gives you the command-line version).
157 * **To instead install Chicken Scheme on Mac without MacPorts**
159 Here are the exact steps I just verified worked. Note that I *first installed the Haskell Platform*, described further down this page; that installed some developer tools that were needed to build and install Chicken. If you don't know how to open a Terminal, move between directories, copy / rename / delete files and so on, then you're probably best off not doing this. You could break something.
161 1. Go to <http://code.call-cc.org>, and click the "Source code" link near the top. Current version is 4.9.0.1, released November 2014. This should fetch a file to your download folder, and will probably automatically unpack that file into a folder, "chicken-4.9.0.1". Click on that folder and press command-C / Copy, then open a Terminal.
162 2. In the terminal type `cd` followed by a space, then press command-V / Paste. Then press enter. This will move your session into the folder you just downloaded.
163 3. Type `less README` and read that file.
164 4. Type `sudo mkdir -p /usr/local`
165 5. Type `make PLATFORM=macosx XCODE_DEVELOPER= XCODE_TOOL_PATH=/usr/bin`
167 The options starting with `XCODE_` are to tell the Chicken build scripts that I've got the developer tools installed in my main system, rather than as part of Xcode. (That's where the Haskell Platform installer put them.) Continuing:
169 6. Wait a while while Chicken builds.
170 7. If it finishes with no errors, then type `sudo make PLATFORM=macosx XCODE_TOOL_PATH=/usr/bin install`. This will prompt you for your account password, and then install Chicken underneath your `/usr/local` directory.
171 8. At this point you can type `which chicken`. If it gives you an answer of "/usr/local/bin/chicken", then skip to the next step. Else you should type `echo 'export PATH=/usr/local/bin:$PATH' >> ~/.bashrc`, then exit and restart your Terminal session.
172 9. In your terminal, type `chicken-install -sudo r7rs datatype matchable monad`. This will download, build, and install a few extensions (Chicken calls them "eggs") relevant to ideas we'll be working with in this course.
174 * **To install on Mac with MacPorts**
176 Unfortunately, MacPorts doesn't have Racket itself available. It only has an older version from when they still called
177 themselves PLT Scheme. And even then, it only has the command-line program "mzscheme" (what's nowadays called "racket"); it
178 doesn't have the GUI program that corresponds to what's now called "DrRacket". You can install mzscheme by opening a Terminal
181 sudo port install mzscheme
183 <!-- mzscheme v4.1.5, from March 2009; latest mzscheme is 4.2.5, from April 2010 -->
185 If you want the GUI components, I think you'll need to use the
186 "Mac/without MacPorts" installation options above. Or you could try the Chicken Scheme implementation instead of Racket. This is more current.
189 sudo port install chicken readline
191 <!-- chicken v4.8.0.2, from Feb 2013; latest available is 4.9.0.1, from Nov 2014 -->
193 Whether you use mzscheme or Chicken, I recommend also typing:
195 sudo port install rlwrap
197 then if you ever use the command-line program `mzscheme` (or `racket`, for that matter), you should start it by typing `rlwrap mzscheme` (or whatever). This gives
198 you a nice history of the commands you've already typed, which you can scroll up and down in with your
201 * **To install on Linux**
203 Use your packaging system, for example, open a Terminal and
206 sudo apt-get install racket
208 It's very likely that your packaging system has some version of
209 Racket available, so look for it. However, if you can't find it you
210 can also install a pre-packaged binary from the Racket website at <http://racket-lang.org/download/>.
211 Choose the option for your version of Linux (Ubuntu and Debian are available).
213 As above, I recommend you also type:
217 then if you ever use the command-line program `mzscheme` (or `racket`), you should start it by typing `rlwrap mzscheme` (or whatever). This gives
218 you a nice history of the commands you've already typed, which you can scroll up and down in with your
224 **Caml** is one of two major dialects of *ML*, which is another large family of
225 programming languages. The other dialect is called "SML" and has several
226 implementations. But Caml has only one active implementation, OCaml or
227 Objective Caml, developed by the INRIA academic group in France.
228 Sometimes we may refer to Caml or ML
229 more generally; but you can assume that what we're talking about always works more
230 specifically in OCaml.
232 It's helpful if in addition to OCaml you also install the
233 Findlib add-on and/or the [OPAM](https://opam.ocaml.org) "package manager."
234 These will make it easier to install additional add-ons further down the road.
235 However, if you're not able to get them working, don't worry about it much.
237 The current version of OCaml is 4.02.1 (released October 2014).
238 <!-- 3.12.1 July 2011; 4.00.1 Oct 2012; 4.01.0 Sept 2013; 4.02.0 Aug 2014; 4.02.1 Oct 2014 -->
241 * In your web browser:
243 There is a (slow, bare-bones) version of OCaml available for online use at <http://try.ocamlpro.com/>.
246 * **To install in Windows**
248 There are *five* different strategies for installing OCaml on Windows. I don't know which works best.
250 1. First, you can go to <http://caml.inria.fr/download.en.html>.
251 You can probably download and install the
252 "Self installer for the port based on the MinGW toolchain"
253 even if you don't know what MinGW or Cygwin are.
254 Some features of this require Cygwin, but it looks like
255 it should mostly work even for users without Cygwin.
256 At the time of this writing, only an installer for an earlier
257 version of OCaml (4.01.0, from September 2013) is available.
259 2. A second strategy uses a package called
260 [OCPWIN](http://ocaml.org/docs/install.html#OCPWINSelfContainedOCamlforWindows). This also installs only version 4.01.0.
262 3. The [three remaining strategies](http://ocaml.org/docs/install.html#OCamlonCygwin) in some way
263 use the Cygwin environment, mentioned earlier on this page. At least one of
264 those three methods will automatically fetch and help you install Cygwin.
265 The first method listed on that page says it installs version 4.00.1, but
266 really it's been updated and now installs the (somewhat newer, but still
267 not the newest) version 4.01.0.
269 Some of these methods may automatically install Findlib for you. If not,
270 you can try installing it yourself but I think you'll need the Cygwin
271 system installed to do so. I'm not going to explain how to do this.
272 If you want to figure it out yourself, go to the
273 Findlib website at <http://projects.camlcity.org/projects/findlib.html>.
275 * **To install on Mac without MacPorts**
277 The people in charge of OCaml (they're at the French research institute INRIA) have stopped making pre-built packages for Mac OS X. One option you have is to use their package for a slightly older version of OCaml, 4.01.1 from Sept. 2013. You can find that as a "Precompiled binary for Mac OS X" on [this page](http://ocaml.org/releases/4.01.0.html).
279 A second option is to install the OPAM package manager and use that to build and install the latest version of OCaml. *Instructions on how to do that will be posted shortly.*
282 *Another instruction page focuses on [OPAM](http://ocaml.org/docs/install.html), also [this](https://opam.ocaml.org).*
284 *[More details about installing OCaml on Macs, if needed](http://mirror.ocamlcore.org/wiki.cocan.org/getting_started_with_ocaml_on_mac_os_x.html)*
286 To install OCaml 3.12 (just released this summer), go to
287 <http://caml.inria.fr/download.en.html>
288 and download and install the "Binary distribution for Mac OS X"
290 To install the Findlib add-on, you'll need the Xcode development tools
291 to compile it yourself. Once you get that far, it's probably easiest
292 for you to install MacPorts and just install things using the MacPorts
293 instructions. (Use the MacPorts version of OCaml, instead of installing
294 the package from the caml.inria.fr website, as described above)
295 However, if you do have Xcode, and want to do without MacPorts, then
296 what you need to do is download Findlib from
297 <http://download.camlcity.org/download/findlib-1.2.6.tar.gz>.
298 Unpack the download, open a Terminal and go into the folder you just
304 This will build an installer package which you should be able to
305 double-click and install.
308 * **To install on Mac with MacPorts**
310 You can install the current version of OCaml (4.02.1, from October 2014),
311 together with the Findlib add-on and OPAM package manager, by opening a Terminal and typing:
313 sudo port install ocaml caml-findlib opam
315 As with Scheme, it's helpful to also have rlwrap installed, and to start OCaml as `rlwrap ocaml`. This gives
316 you a nice history of the commands you've already typed, which you can scroll up and down in with your
319 * **To install on Linux**
321 Use your packaging system, for example, open a Terminal and
324 sudo apt-get install ocaml ocaml-findlib opam
326 That will install a version of OCaml and the Findlib add-on and OPAM package manager.
328 If for some reason you can't get OCaml through your
329 packaging system, you can go to
330 <http://caml.inria.fr/download.en.html>.
331 Pre-packaged binary installers are available for several Linux systems.
333 If you can't get findlib through your packaging system, you'll
334 need to download it from
335 <http://download.camlcity.org/download/findlib-1.5.5.tar.gz>.
336 and use gcc to compile it yourself. If you don't know how to
337 do that, you probably don't want to attempt this.
338 Here are the INSTALL notes:
339 <https://godirepo.camlcity.org/svn/lib-findlib/trunk/INSTALL>.
341 As with Scheme, it's helpful to also have rlwrap installed, and to start OCaml as `rlwrap ocaml`. This gives
342 you a nice history of the commands you've already typed, which you can scroll up and down in with your
346 ## Getting Haskell ##
348 This last installation is less crucial than the others, since we will be focusing
349 primarily on Scheme and OCaml. However we, and the readings you come across,
350 will sometimes mention Haskell, so it might be worth your installing this too,
351 so that you have it available to play around with.
353 Haskell is used a lot in the academic contexts we'll be working through. At one point, Scheme
354 dominated these discussions but now Haskell seems to do that.
356 Haskell's surface syntax differs from Caml, and there are various important things one can do in
357 each of Haskell and Caml that one can't (or can't as easily) do in the
358 other. But these languages also have *a lot* in common, and if you're
359 familiar with one of them, it's generally not hard to move between it and the
362 * In your web browser:
364 There is a (slow, bare-bones) version of Haskell available for online use at <http://tryhaskell.org/>.
366 Like Scheme, Haskell has a couple of different implementations. The dominant one, and the one we recommend you install, is called [GHC](https://wiki.haskell.org/GHC), short for "Glasgow Haskell Compiler". To install this on your machine, there are a couple of different strategies. It's helpful to understand some lingo as you begin this process:
368 * As mentioned, **GHC** is the main Haskell engine or compiler you'll be installing. The current version is 7.8.4, from December 2014.
369 * **gcc** and **llvm/clang** and **Xcode** and **MinGW** are names for other compilers on various systems. Oftentimes these will be used during the installation process to get GHC up and running. Some of the strategies described below will help you install these if they're not already on your machine.
370 * **alex** and **happy** and **haddock** are names of various Haskell helper programs that GHC uses to get up and running.
371 * **[Cabal](https://www.haskell.org/cabal)** is a "package manager" for Haskell. It allows you to install libraries or extensions that other people have built. (Usually those are published at the [Hackage](https://hackage.haskell.org) web site.) Some of these are experimental and may not always work; others are quite fundamental and are almost de facto parts of what people expect in a Haskell system.
372 * **[Haskell Platform](https://www.haskell.org/platform)** is a standard bundle that includes a fixed version of GHC, plus fixed versions of some of the most popular libraries or extensions. This is updated once or twice a year. The current version is 2014.2.0.0, from August 2014. It includes GHC version 7.8.3.
374 The easiest way to get up and running with Haskell/GHC is to install the Haskell Platform. Here's how to do that **on Windows**:
376 * Go to <https://www.haskell.org/platform/windows.html> and follow the instructions. It looks like this process will automatically install the MinGW compiler needed to get this build of Haskell running on Windows.
378 On **Mac without MacPorts**:
380 * Go to <https://www.haskell.org/platform/mac.html> and follow the instructions. This requires Mac OS X 10.6 / Snow Leopard or later; but there is a link to an earlier version of Haskell Platform, that's built for Mac OS X 10.5 / Leopard. During the installation, you may be prompted to install "the command line developer tools"; this is a portion of what Apple bundles together with Xcode (mentioned above on this page). The installer will take care of getting these for you if you give it permission.
382 On **Mac with MacPorts**:
384 * In a Terminal, type `sudo port install haskell-platform`.
386 On **Ubuntu or Debian Linux**:
388 * In a Terminal, type `sudo apt-get install haskell-platform`.
391 It's useful to know about the general [Haskell wiki](https://wiki.haskell.org) (not restricted to just GHC). They have a [Getting Started](https://wiki.haskell.org/Haskell_in_5_steps) page, which also recommends that you install the Haskell Platform.
393 If any of the instructions above don't work, then you can try alternative instructions for [Mac](http://new-www.haskell.org/downloads/osx) or [Windows](http://new-www.haskell.org/downloads/windows) or [Ubuntu](http://new-www.haskell.org/downloads/linux). Note that this method doesn't install all the extensions that are part of the Haskell Platform, but only the core pieces of GHC. You can use Cabal to download and manage any extra extensions you turn out to need, down the road.
395 **After installing Haskell**, open a Terminal and type:
399 It may give you a message about updating your `PATH` variable. On my Mac, I first typed `echo $PATH` and verified that `/usr/local/bin` appeared somewhere in the resulting string. (The elements are divided by `:` characters.) Then I typed this:
401 echo 'export PATH="$HOME/Library/Haskell/bin:$PATH"' >> ~/.bash_profile
403 That was to update my `PATH` variable as instructed by Cabal. On a Linux machine, or if you installed Haskell differently on your Mac, you might have to type instead:
405 echo 'export PATH="$HOME/.cabal/bin:$PATH"' >> ~/.bash_profile
407 Some instructions may say to use `.bashrc` instead of `.bash_profile`. These files do similar jobs.
409 After issuing the relevant `echo` command, I exited the Terminal and started a new Terminal session. Now if I type `echo $PATH` I should see the directory I just added in the list. Now I can contine setting up Cabal. I type:
413 If that gives me back two pathnames, one to the program `alex` and the other to the program `happy`, then I'm already finished. If not, then I type:
415 cabal install alex happy
417 This installs those two programs. They are helpers that Cabal needs to build and install some packages.
419 <!-- https://github.com/pittsburgh-haskell/haskell-installation -->