Skip to content

Commit f3fc801

Browse files
committed
Merge pull request purescript#1343 from hdgarrood/install-info
Add installation information
2 parents 634266f + 86c1dc7 commit f3fc801

3 files changed

Lines changed: 49 additions & 0 deletions

File tree

INSTALL.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Installation information
2+
3+
If you are having difficulty installing the PureScript compiler, feel free to
4+
ask for help! A good place is the #purescript IRC channel on Freenode, or
5+
alternatively Stack Overflow.
6+
7+
## Using prebuilt binaries
8+
9+
The prebuilt binaries are compiled with GHC 7.8.3, and therefore they should
10+
run on any operating system supported by GHC 7.8.3, such as:
11+
12+
* Windows 2000 or later,
13+
* OS X 10.7 or later,
14+
* Linux ??? (we're not sure what the minimum version is).
15+
16+
This list is not exhaustive. If your OS is too old or not listed, or if the
17+
binaries fail to run, you may be able to install the compiler by building it
18+
from source; see below.
19+
20+
It's probably safe to assume that other prebuilt distributions (eg, Homebrew,
21+
Chocolatey, AUR, npm) use the same binaries, and therefore have the same
22+
requirements.
23+
24+
## Compiling from source
25+
26+
GHC 7.6.1 or newer is required to compile from source. The easiest way is to
27+
use `cabal-install`:
28+
29+
```
30+
$ cabal update && cabal install purescript
31+
```
32+
33+
The PureScript compiler has been known to run on OS X 10.6 when built with GHC
34+
7.6.
35+
36+
## The "curses" library
37+
38+
`psci` depends on the `curses` library (via the Haskell package `terminfo`). If
39+
you are having difficulty running the compiler, it may be because the `curses`
40+
library is missing.
41+
42+
On Linux, you will probably need to install `ncurses` manually. On Ubuntu, for
43+
example, this can be done by running:
44+
45+
```
46+
$ sudo apt-get install libncurses5-dev
47+
```

bundle/build.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ cp ../dist/build/psc-publish/psc-publish build/purescript/
3030
cp ../dist/build/psc-bundle/psc-bundle build/purescript/
3131
cp README build/purescript/
3232
cp ../LICENSE build/purescript/
33+
cp ../INSTALL.md build/purescript/
3334

3435
# Make the binary bundle
3536
pushd build > /dev/null

bundle/winbuild.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ cp ../dist/build/psc-publish/psc-publish.exe build/purescript/
2626
cp ../dist/build/psc-bundle/psc-bundle.exe build/purescript/
2727
cp README build/purescript/
2828
cp ../LICENSE build/purescript/
29+
cp ../INSTALL.md build/purescript/
2930

3031
# Make the binary bundle
3132
pushd build

0 commit comments

Comments
 (0)