From 55bc2e3e38e61a625fe46157c703153c1655f6e9 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Tue, 13 Sep 2016 09:00:17 -0700 Subject: [PATCH] site: download page updates (#400) Update commands, more detail, mention cabal again, begin suggesting os-specific C libs --- site/download.md | 85 ++++++++++++++++++++++++++++-------------------- 1 file changed, 50 insertions(+), 35 deletions(-) diff --git a/site/download.md b/site/download.md index 0467b373c..87249dddf 100644 --- a/site/download.md +++ b/site/download.md @@ -39,19 +39,19 @@ and/or **on Debian or Ubuntu** -`apt-get install hledger hledger-web` +`sudo apt-get install hledger hledger-web` + + + +**on Fedora or RHEL** + +`sudo dnf install hledger` **on Gentoo** -`layman -a haskell && emerge hledger hledger-web` - - - -**on Fedora** - -`yum install hledger` +`sudo (layman -a haskell && emerge hledger hledger-web)` @@ -82,22 +82,49 @@ This is a quick way to help the project and your fellow users! ## I want to build the latest released version - +The latest release may be newer than your OS's packaged version. +(Here are the latest [release notes](release-notes.html).) -1. Install [`stack`](http://haskellstack.org) - (On Windows, the 64-bit version is [recommended](https://github.com/simonmichael/hledger/issues/275).) - -2. `stack setup` - (if you need GHC installed. If you're not sure, run the next command and it will tell you.) -3. `stack install hledger [hledger-ui] [hledger-web]` - (hledger-ui is not supported on Windows) -4. Ensure `~/.local/bin` or the Windows equivalent is in your `$PATH`, - so that you can just type `hledger` to run it. - (stack will show the proper directory and will tell you if it is not in $PATH). +1. Install [`stack`](http://haskellstack.org). + On Windows, the 64-bit version is [recommended](https://github.com/simonmichael/hledger/issues/275). + +2. `stack setup` to ensure you have the required version of [GHC](https://www.haskell.org/ghc). + +3. `stack install hledger [hledger-ui] [hledger-web]`\ + hledger-ui and hledger-web take longer to build. hledger-ui is not buildable on Windows. + +4. If stack warns that `~/.local/bin` or the Windows equivalent is not in your `$PATH`, + configure that, so that the command `hledger` will work. + Eg if you're a bash user:\ + `echo "export PATH=$PATH:~/.local/bin" >> ~/.bashrc && source ~/.bashrc` + +Or use [`cabal`](https://www.haskell.org/cabal/) if you prefer and know how. +It's harder to use and to support, so these docs focus on stack. + +**Note:** Haskell builds can fail due to missing C libraries or headers, which stack/cabal can not install. +If you have this problem, here are some C libs you might need (updates welcome): + +| +|-------------------------|----------------------------------- +| **on Debian or Ubuntu** | +| **on Fedora or RHEL** | `sudo dnf install ncurses-devel` + + + + +## I want to build the [latest development version](https://github.com/simonmichael/hledger/commits/master) + +This includes the latest features and is normally stable enough for daily use; recommended. + + +1. `git clone http://code.hledger.org hledger` +2. `cd hledger` +3. `stack install [hledger] [hledger-ui] [hledger-web] [hledger-api]` + +cabal users, try `./cabal-install.sh` instead. + -Here are the [release notes](release-notes.html). - - - -## I want to build the [latest development version](https://github.com/simonmichael/hledger/commits/master) - -1. `git clone http://code.hledger.org hledger` -2. `cd hledger` -3. `stack install [hledger] [hledger-ui] [hledger-web] [hledger-api]` - -This is what I use day to day. Includes the latest features, recommended. - -