slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: download: more edits

Browse Source 
[ci skip]
This commit is contained in:
Simon Michael 2018-02-17 04:44:41 -08:00
parent f4cc946ae6
commit 8fb2479267
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
site/download.md
View File

@ -37,30 +37,30 @@ but they can be [out of date](https://repology.org/metapackage/hledger/badges) o
## B. build the latest release ? ## B. build the latest release ?
Good choice! The [release notes](release-notes.html) show what you'll get. Good choice! The [release notes](release-notes.html) show what you'll get.
Below are three ways to build hledger, in order of preference.
A slight warning: the first build of a haskell application can take But first, a slight warning: the first build of a haskell application can take
significant time (minutes to hours), memory (eg 1G+), and disk space significant time (minutes to 1 hour), memory (eg 1G+), and disk space
(eg 1G in ~/.stack or ~/.cabal). On the upside, it can be left (eg 1G in ~/.stack or ~/.cabal). On the upside, it can be left
unattended, you can kill and restart it without losing progress, and unattended, you can kill and restart it without losing progress, and
subsequent builds will be quicker. subsequent builds will be quicker.
Here are three ways to build hledger, in order of preference:\ Current build issues/workarounds:
(and some current issues/workarounds:
[freebsd 12](https://github.com/simonmichael/hledger/issues/709) [freebsd 12](https://github.com/simonmichael/hledger/issues/709)
)
### 1. hledger-install ### 1. hledger-install
On POSIX systems (linux/mac/bsd...), On POSIX systems (linux, mac, *bsd, unixlike environments on windows..),
[hledger-install.sh](https://github.com/simonmichael/hledger/tree/master/hledger-install) our [hledger-install.sh](https://github.com/simonmichael/hledger/tree/master/hledger-install)
is the build method most likely to just work: is the build method most likely to just work:
- it requires only that you have bash and curl (or wget) installed, and internet access. - it requires only that you have bash and curl (or wget) installed, and internet access.
- it uses haskell build tools like stack, cabal and GHC, installing stack/GHC if needed (in ~/.stack). - it uses haskell build tools like stack, cabal and GHC, installing stack/GHC if needed (in ~/.stack).
- it installs the latest release of hledger and its suite of addon tools - it avoids common pitfalls, such as unreliable build plans and all-or-nothing builds
- it installs the latest release of hledger and the full suite of addon tools
(in ~/.local/bin or ~/.cabal/bin). (in ~/.local/bin or ~/.cabal/bin).
Here's the easy, non-secure way to run it: Here's the quick, non-secure way to run it:
**`curl https://raw.githubusercontent.com/simonmichael/hledger/master/hledger-install/hledger-install.sh | bash`** **`curl https://raw.githubusercontent.com/simonmichael/hledger/master/hledger-install/hledger-install.sh | bash`**
@ -68,12 +68,12 @@ And here's the safer, more responsible way:
**`curl -O https://raw.githubusercontent.com/simonmichael/hledger/master/hledger-install/hledger-install.sh`**\ **`curl -O https://raw.githubusercontent.com/simonmichael/hledger/master/hledger-install/hledger-install.sh`**\
**`less hledger-install.sh`** *# do security review*\ **`less hledger-install.sh`** *# do security review*\
**`bash hledger-install.sh`** *# run it* **`bash hledger-install.sh`** *# or bash -x, to log commands*
If you have any trouble, you can help greatly by capturing a debug log If you have any trouble, you can help greatly by capturing a debug log
and sending it to me via and sending it to me via
[paste](http://paste.hledger.org) & [IRC](http://irc.hledger.org), [paste](http://paste.hledger.org) & [IRC](http://irc.hledger.org),
or an [issue](http://bugs.hledger.org) an [issue](http://bugs.hledger.org),
or [email](docs.html#helpfeedback): or [email](docs.html#helpfeedback):
**`bash -x hledger-install.sh 2>&1 | tee hledger-install.log`** **`bash -x hledger-install.sh 2>&1 | tee hledger-install.log`**