From 732611086d08e09145de2d21a708de6dcf134e20 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Sat, 28 Apr 2018 12:34:59 -0700 Subject: [PATCH] site: download: clarify structure --- site/download.md | 27 +++++++++++++++++---------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/site/download.md b/site/download.md index 62959a178..bf9896cf8 100644 --- a/site/download.md +++ b/site/download.md @@ -2,10 +2,10 @@ # Download -Do you want to.. +Adventurer, choose your path! No, really it's quite easy. Often. Do you want to.. -## A. download a binary/system package ? +## a. download a binary/system package -Binaries/system packages are quickest to install -(but they can be [out of date](https://repology.org/metapackage/hledger/badges) or incomplete). +hledger binaries or system packages are quickest to install, +but they can be [out of date](https://repology.org/metapackage/hledger/badges) or incomplete. +(Please help your local packagers with this!). | @@ -46,7 +47,7 @@ Binaries/system packages are quickest to install -## B. build the latest release ? +## b. build the latest release Good choice! You'll get the latest features mentioned in the [release notes](release-notes.html). Below are three ways to build the latest release, in order of preference. @@ -65,7 +66,9 @@ Also, here are some known build issues and workarounds:\ [openbsd: how to get stack](https://github.com/commercialhaskell/stack/issues/2822#issuecomment-318892816)\ -### hledger-install + + +### b1. with hledger-install Our [hledger-install script](https://github.com/simonmichael/hledger/tree/master/hledger-install) is recommended as the easiest and most-likely-to-just-work build method, @@ -131,7 +134,9 @@ or [email](docs.html#helpfeedback): **`bash -x hledger-install.sh 2>&1 | tee hledger-install.log`** -### stack + + +### b2. with stack [`stack`](http://haskell-lang.org/get-started) is the newer and easier of the Haskell build tools. If you prefer more control or if hledger-install failed, here's how to use stack yourself: @@ -181,13 +186,15 @@ If you prefer more control or if hledger-install failed, here's how to use stack 6. **[Test](#test)** -### cabal + -[cabal](https://www.haskell.org/cabal/) is the other Haskell build tool. If you're a cabal expert, feel free to use this instead. +### b3. with cabal + +[cabal](https://www.haskell.org/cabal/) is the other Haskell build tool. If you're a cabal expert, feel free to use this in the usual way. -## C. build the development version ? +## c. build the development version Also a good choice. Our master branch is stable enough for daily use, and includes the [latest improvements](https://github.com/simonmichael/hledger/commits/master).