Skip to content

Added installation instructions for Mac and Windows #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mikeizbicki wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added installation instructions for Mac and Windows #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions snaplets/heist/templates/docs/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,29 @@

If you haven't already done so, first go to the [download](/download) page to
find out how to install Snap. The installation generates an executable called
`snap` that you can use to get started with a basic snap project. By default,
`cabal` will install executables to "`$HOME/.cabal/bin`". To add `cabal` to your `$PATH`, add
`snap` that you can use to get started with a basic snap project.

Our first step is to complete the installation process by adding `snap` to our `PATH`.
This step depends on your exact system configuration. Below are the commands for the
default configurations of the haskell platform on Linux, Mac, and Windows.

On Linux, the command is:
~~~~~~ {.shell}
PATH=$HOME/.cabal/bin:$PATH
~~~~~~

to your `~/.bashrc` and run `source ~/.bashrc`. The following
On MacOS, the command is:
~~~~~ {.shell
PATH=$HOME/Library/Haskell/bin:$PATH
~~~~~

On Windows (with cygwin), the command is:
~~~~~ {.shell}
PATH=/cygdrive/c/Users/yourusername/AppData/Roaming/cabal/bin:$PATH
~~~~~
(you must replace yourusername with your actual user name.)

Add the appropriate command to your `~/.bashrc`, then run `source ~/.bashrc`. The following
instructions assume that `$HOME/.cabal/bin` is on your `$PATH`.

To set up a new Snap project, run the following commands:
Expand Down