summaryrefslogtreecommitdiff
path: root/INSTALL.md
diff options
context:
space:
mode:
authorPhilFreeman <>2015-10-20 20:31:00 (GMT)
committerhdiff <hdiff@hdiff.luite.com>2015-10-20 20:31:00 (GMT)
commit02ef1718f713f0ba740b412d9c746a6528e315f0 (patch)
tree6183f46dcca728a374cb2f6d6c54da07a4a14a7e /INSTALL.md
parent414866c38a08e4a8a56cc3b7e8b0712743cb9551 (diff)
version 0.7.50.7.5
Diffstat (limited to 'INSTALL.md')
-rw-r--r--INSTALL.md57
1 files changed, 57 insertions, 0 deletions
diff --git a/INSTALL.md b/INSTALL.md
new file mode 100644
index 0000000..5e4bc78
--- /dev/null
+++ b/INSTALL.md
@@ -0,0 +1,57 @@
+# Installation information
+
+If you are having difficulty installing the PureScript compiler, feel free to
+ask for help! A good place is the #purescript IRC channel on Freenode, or
+alternatively Stack Overflow.
+
+## Using prebuilt binaries
+
+The prebuilt binaries are compiled with GHC 7.8.4, and therefore they should
+run on any operating system supported by GHC 7.8.4, such as:
+
+* Windows 2000 or later,
+* OS X 10.7 or later,
+* Linux ??? (we're not sure what the minimum version is).
+
+This list is not exhaustive. If your OS is too old or not listed, or if the
+binaries fail to run, you may be able to install the compiler by building it
+from source; see below.
+
+It's probably safe to assume that other prebuilt distributions (eg, Homebrew,
+Chocolatey, AUR, npm) use the same binaries, and therefore have the same
+requirements.
+
+## Compiling from source
+
+GHC 7.6.1 or newer is required to compile from source. The easiest way is to
+use stack:
+
+```
+$ stack install purescript
+```
+
+This will then copy the compiler and utilities into `~/.local/bin`.
+
+
+If you don't have stack installed yet there are install instructions
+[here](https://github.com/commercialhaskell/stack/blob/master/doc/install_and_upgrade.md).
+
+If you don't have ghc installed yet, stack will prompt you to run `stack setup`
+which will install ghc for you.
+
+The PureScript compiler has been known to run on OS X 10.6 when built with GHC
+7.6.
+
+
+## The "curses" library
+
+`psci` depends on the `curses` library (via the Haskell package `terminfo`). If
+you are having difficulty running the compiler, it may be because the `curses`
+library is missing.
+
+On Linux, you will probably need to install `ncurses` manually. On Ubuntu, for
+example, this can be done by running:
+
+```
+$ sudo apt-get install libncurses5-dev
+```