haskell/stackage
1
0
Fork 0
mirror of https://github.com/commercialhaskell/stackage.git synced 2026-02-10 05:17:30 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Quote the value of the PATH variable and other minor changes

Rufflewind 2014-09-07 13:09:01 -07:00
parent bb6c89303d
commit b6876157b3
1 changed files with 76 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
Preparing-your-system-to-use-Stackage.md → Preparing your system to use Stackage.md

@ -1,6 +1,6 @@
# Overview # Overview
These instructions are for users wishing to use [Stackage Server](http://www.stackage.org/) as their package repository. There are two different tools that need to be installed on your system to use Stackage Server: GHC, and cabal-install. There are generally speaking two ways of getting these tools: via [Haskell Platform](http://www.haskell.org/platform/), or installing them separately. We'll cover these options in a bit. These instructions are for users wishing to use [Stackage Server](http://www.stackage.org/) as their package repository. There are two different tools that need to be installed on your system to use Stackage Server: GHC, and cabal-install. There are generally speaking two ways of getting these tools: via [Haskell Platform](https://www.haskell.org/platform/), or installing them separately. We'll cover these options in a bit.
Currently, we support three different system configurations. Each of these options has its own set of Stackage snapshots available, and each of these in turn has [exclusive and inclusive variants](https://github.com/fpco/stackage/wiki/Stackage-Server-FAQ#whats-the-difference-between-inclusive-and-exclusive-snapshots). Currently, we support three different system configurations. Each of these options has its own set of Stackage snapshots available, and each of these in turn has [exclusive and inclusive variants](https://github.com/fpco/stackage/wiki/Stackage-Server-FAQ#whats-the-difference-between-inclusive-and-exclusive-snapshots).
@ -24,19 +24,20 @@ Stackage Server is designed to work either with or without Haskell Platform. The
This applies to both Haskell Platform and manual installs. A very common source of confusion for new users is that executables are not available. For example, "I ran `cabal install alex`, but it's complaining that `alex` isn't available." It's __vitally important__ that you make sure that your PATH environment variable is configured to include cabal's bin directory. This applies to both Haskell Platform and manual installs. A very common source of confusion for new users is that executables are not available. For example, "I ran `cabal install alex`, but it's complaining that `alex` isn't available." It's __vitally important__ that you make sure that your PATH environment variable is configured to include cabal's bin directory.
On most POSIX systems, this directory will be `$HOME/.cabal/bin`. A simple way to do this is to edit your ~/.bashrc and place in there: On most POSIX systems, this directory will be `$HOME/.cabal/bin`. A simple way to do this is to edit your `~/.bashrc` and place in there:
export PATH=$HOME/.cabal/bin:$PATH ```bash
export PATH="$HOME/.cabal/bin:$PATH"
```
In Mac OS X, cabal installs binaries to: `~/Library/Haskell/bin/`. In Mac OS X, cabal installs binaries to: `$HOME/Library/Haskell/bin`.
In Windows Vista or newer Windows, cabal installs binaries to: `%APPDATA%\cabal\bin`. In Windows Vista or newer Windows, cabal installs binaries to: `%APPDATA%\cabal\bin`.
`%APPDATA` is Windows specific Environment variable. `%APPDATA%` is Windows specific Environment variable. Usually, this variable specifies `C:\Users\%USERNAME%\AppData\Roaming`.
Usually, this variable specifies `C:\Users\<username>\AppData\Roaming`.
## Haskell Platform ## Haskell Platform
If you've elected to install Haskell Platform, please follow the instructions [on the Haskell Platform website](http://www.haskell.org/platform/). If you've elected to install Haskell Platform, please follow the instructions [on the Haskell Platform website](https://www.haskell.org/platform/).
__NOTE__: Distributions like Ubuntu often include a package including the Haskell Platform. Often, this package is very out-of-date, and will not be compatible with either Stackage Server or most recent releases of software on Hackage. Be sure you're installing version 2014.2.0.0 of the platform. __NOTE__: Distributions like Ubuntu often include a package including the Haskell Platform. Often, this package is very out-of-date, and will not be compatible with either Stackage Server or most recent releases of software on Hackage. Be sure you're installing version 2014.2.0.0 of the platform.
@ -60,12 +61,16 @@ Or you can even install from source, for which there is documentation.
After installing GHC, you will want the Haskell package manager: After installing GHC, you will want the Haskell package manager:
[Get the Cabal archive →](http://hackage.haskell.org/package/cabal-install) [Get the Cabal archive →](https://hackage.haskell.org/package/cabal-install)
Download the tar.gz file (listed under Downloads at the bottom of the page), extract and inside the resulting directory, run: Download the tar.gz file (listed under Downloads at the bottom of the page), extract and inside the resulting directory, run:
$ sh ./bootstrap.sh ```sh
$ sh ./bootstrap.sh
```
This will automatically download and install all the packages necessary to setup Cabal install. You should now be able to run the `cabal` executable. To test this, run: This will automatically download and install all the packages necessary to setup Cabal install. You should now be able to run the `cabal` executable. To test this, run:
cabal update ```sh
$ cabal update
```