mirror of
https://github.com/simonmichael/hledger.git
synced 2024-09-19 10:17:35 +03:00
;site: download: reorganise with binaries at top, cleanup, add TOC
[ci skip]
This commit is contained in:
Simon Michael
parent
54a6ee2c64
commit
a7ffa6108b
7
Shake.hs
7
Shake.hs
@ -421,11 +421,13 @@ main = do
|
||||
|
||||
-- Render one website page (main or wiki) as html, saved in sites/_site/.
|
||||
-- Wiki pages will have a heading and TOC placeholder prepended.
|
||||
-- The download page will have a TOC placeholder prepended.
|
||||
-- All pages will have github-style wiki links hyperlinked.
|
||||
"site/_site//*.html" %> \out -> do
|
||||
let filename = takeBaseName out
|
||||
pagename = fileNameToPageName filename
|
||||
iswikipage = filename `elem` wikipagefilenames
|
||||
isdownloadpage = filename == "download"
|
||||
isoldmanual = "site/_site/doc/" `isPrefixOf` out
|
||||
source
|
||||
| iswikipage = "wiki" </> filename <.> "md"
|
||||
@ -433,9 +435,12 @@ main = do
|
||||
| otherwise = "site" </> filename <.> "md"
|
||||
template = "site/site.tmpl"
|
||||
siteRoot = if "site/_site/doc//*" ?== out then "../.." else "."
|
||||
maybeAddToc | iswikipage = addHeading pagename . addToc
|
||||
| isdownloadpage = addToc
|
||||
| otherwise = id
|
||||
need [source, template]
|
||||
-- read markdown source, link any wikilinks, maybe add a heading and TOC, pipe it to pandoc, write html out
|
||||
Stdin . wikiLink . (if iswikipage then addHeading pagename . addToc else id) <$> (readFile' source) >>=
|
||||
Stdin . wikiLink . maybeAddToc <$> (readFile' source) >>=
|
||||
(cmd Shell pandoc "-" fromsrcmd "-t html"
|
||||
"--template" template
|
||||
("--metadata=siteRoot:" ++ siteRoot)
|
||||
|
||||
199
site/download.md
199
site/download.md
@ -1,15 +1,5 @@
|
||||
# Download
|
||||
|
||||
Here are the ways to install hledger, organised by platform, with the usually most up-to-date methods at the top.
|
||||
|
||||
(
|
||||
hledger's usual release window is the first day or two of the month.
|
||||
Please [send updates](index.html#helpfeedback) for
|
||||
[this page](https://github.com/simonmichael/hledger/blob/master/site/download.md),
|
||||
and help packagers keep packages up to date.
|
||||
Click the version badges on the right for package/contact info.
|
||||
)
|
||||
|
||||
<style>
|
||||
table { margin-left:1em; }
|
||||
tr { /*border-top:thin solid #ddd;*/ border-bottom:thin solid #ddd; }
|
||||
@ -34,20 +24,31 @@ a { white-space:nowrap; }
|
||||
}
|
||||
</style>
|
||||
|
||||
| | | Latest release is 1.14.2<br>[Release notes](release-notes.html) <!-- should be the latest release of the hledger package --> <!-- [](http://hledger.org/release-notes) --> |
|
||||
Here are some ways to install hledger - choose one that suits you.
|
||||
And please do [let us know](index.html#helpfeedback) or
|
||||
[update this page](https://github.com/simonmichael/hledger/blob/master/site/download.md)
|
||||
if you have any trouble.
|
||||
|
||||
The current hledger release is **1.14.2**; here are the [release notes](release-notes.html).
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
## Binary packages
|
||||
|
||||
These prebuilt binaries will install quickly:
|
||||
|
||||
| | |
|
||||
|-----------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| <br><big>**Multiplatform**</big> | <br><small>*The first three (and occasionally the fourth) build from source, which is slower. See [Building from source](#b).*</small> | <br><small>*This method installs:*</small> |
|
||||
| [hledger-install.sh](#b1)<br><small>*Linux, Mac, WSL*</small><br><small>*Requires only bash.*</small> | <span style="font-size:small;">**`curl -sO https://raw.githubusercontent.com/simonmichael/hledger/master/hledger-install/hledger-install.sh`**<br>**`less hledger-install.sh`** *# satisfy yourself that the script is safe*<br>**`bash hledger-install.sh`**</span> | <small>Latest release</small> |
|
||||
| [cabal]<br><small>*Linux, Mac, Windows[*]*</small> | <span style="font-size:medium;">**`cabal v2-update && cabal v2-install hledger-1.14.2 hledger-web-1.14.1 hledger-ui-1.14.2`**</span> | <small>Latest release</small> |
|
||||
| [stack]<br><small>*Linux, Mac, Windows[*]*</small> | <span style="font-size:medium;">**`stack install --resolver=nightly-2019-03-21 hledger hledger-web hledger-ui`**</span> | <small>Latest release</small> |
|
||||
| [Nix]<br><small>*Linux, Mac*</small> | <span style="font-size:small;">**`nix-env -i -f https://github.com/NixOS/nixpkgs/archive/9c74e2.tar.gz -A hledger hledger-web hledger-ui`**</span> | <small>Latest release</small> |
|
||||
| <br><big>**Multiplatform**</big> | | <br><small>*Packaged version:*</small> |
|
||||
| [Nix]<br><small>*Linux, Mac*</small> | <span style="font-size:small;">**`nix-env -i -f https://github.com/NixOS/nixpkgs/archive/9c74e2.tar.gz -A hledger hledger-web hledger-ui`**</span> | 
|
||||
| [Docker]<br><small>*Linux, Mac, Windows*</small> | **`docker pull dastapov/hledger`** | [](https://hub.docker.com/r/dastapov/hledger)<br><small>[more..](https://hub.docker.com/search?q=hledger&type=image&sort=updated_at&order=desc)</small> |
|
||||
| [Homebrew]<br><small>*Linux, Mac, Windows*</small> | **`brew install hledger`** | [](https://formulae.brew.sh/formula/hledger) |
|
||||
| [Wine]<br><small>*Linux, Mac, FreeBSD*</small> | *run the Windows binary below :)* | |
|
||||
| [Homebrew]<br><small>*Linux, Mac, Windows*</small> | **`brew install hledger`** | [](https://formulae.brew.sh/formula/hledger) |
|
||||
| [Wine]<br><small>*Linux, Mac, FreeBSD*</small> | *Install Wine, run the Windows binary below* | |
|
||||
| <br><big>**Windows**</big> | | |
|
||||
| Windows binaries | <code>**[hledger.zip]**</code> <small>*from Appveyor CI*</small> <!-- or [latest nightly dev build](https://ci.appveyor.com/api/projects/simonmichael/hledger/artifacts/hledger.zip?branch=master) --><!-- <span class=warnings> [no hledger-ui](https://github.com/jtdaugherty/vty/pull/1#issuecomment-297143444),[doesn't work on old windows ?](https://github.com/simonmichael/hledger/issues/774),[many files in PATH causing hangs](https://github.com/simonmichael/hledger/issues/791) --><!-- ,[appveyor builds failing](https://github.com/simonmichael/hledger/issues/832) </span>--> | [](https://ci.appveyor.com/project/simonmichael/hledger/build/artifacts) |
|
||||
| Windows binaries | <code>**[hledger.zip]**</code> *from Appveyor CI* <!-- or [latest nightly dev build](https://ci.appveyor.com/api/projects/simonmichael/hledger/artifacts/hledger.zip?branch=master) --><!-- <span class=warnings> [no hledger-ui](https://github.com/jtdaugherty/vty/pull/1#issuecomment-297143444),[doesn't work on old windows ?](https://github.com/simonmichael/hledger/issues/774),[many files in PATH causing hangs](https://github.com/simonmichael/hledger/issues/791) --><!-- ,[appveyor builds failing](https://github.com/simonmichael/hledger/issues/832) </span>--> | [](https://ci.appveyor.com/project/simonmichael/hledger/build/artifacts) |
|
||||
| <br><big>**GNU/Linux**</big> | | |
|
||||
| Arch | **`pacman -S hledger hledger-ui hledger-web`** | [](https://www.archlinux.org/packages/?sort=&q=hledger) |
|
||||
| Arch | **`pacman -S hledger hledger-ui hledger-web`** | [](https://www.archlinux.org/packages/?sort=&q=hledger) |
|
||||
| Gentoo | **`sudo layman -a haskell && sudo emerge hledger hledger-ui hledger-web`** | [](https://gentoo.zugaina.org/Search?search=hledger) |
|
||||
| Debian | **`sudo apt install hledger hledger-ui hledger-web`** | [](https://packages.debian.org/unstable/hledger)<br>[](https://packages.debian.org/testing/hledger)<br>[](https://packages.debian.org/stable/hledger)<br>[](https://packages.debian.org/oldstable/hledger)<br><small>[more..](https://packages.debian.org/search?searchon=names&keywords=hledger)</small> |
|
||||
| Ubuntu | **`sudo apt install hledger hledger-ui hledger-web`** | [](https://packages.ubuntu.com/disco/hledger)<br>[](https://packages.ubuntu.com/cosmic/hledger)<br>[](https://packages.ubuntu.com/bionic/hledger)<br>[](https://packages.ubuntu.com/xenial/hledger)<br>[](https://packages.ubuntu.com/trusty/hledger)<br><small>[more..](https://packages.ubuntu.com/search?suite=all&searchon=names&keywords=hledger)</small> |
|
||||
@ -60,7 +61,6 @@ a { white-space:nowrap; }
|
||||
|
||||
<!-- <br><br><small>*Or: (nix-channel --update may be needed. CI [build][nix unstable linux builds] [issues][nix unstable mac builds] may cause failure/large downloads; check those links/try with --dry-run first)*</small> <br><span style="font-size:small;">**`nix-env -i hledger-1.14.2 hledger-ui-1.14.2 hledger-web-1.14.1`**</span> -->
|
||||
|
||||
[*]: #windows-build-issues
|
||||
[Docker]: https://www.docker.com/products/docker-desktop
|
||||
[Homebrew]: https://brew.sh
|
||||
[Linuxbrew]: https://linuxbrew.sh
|
||||
@ -102,96 +102,50 @@ a { white-space:nowrap; }
|
||||
[repology badges, sometimes out of date]: https://repology.org/project/hledger/badges
|
||||
[custom badges]: https://shields.io
|
||||
|
||||
[hledger-install.sh]: https://github.com/simonmichael/hledger/blob/master/hledger-install/hledger-install.sh
|
||||
|
||||
<a name="b"></a>
|
||||
|
||||
## Building from source
|
||||
|
||||
Building hledger from source takes a bit longer than using a prebuilt package,
|
||||
but you can be sure of getting the latest release (or the latest dev version).
|
||||
You can build hledger wherever the Glasgow Haskell Compiler is supported.
|
||||
This can take a while, but it's normally a reliable process.
|
||||
Use one of the methods below to build the current hledger release.
|
||||
The hledger-install script requires only bash and installs the required tools.
|
||||
Or, you can install stack or cabal yourself and deal with them directly.
|
||||
|
||||
Below are three ways to build hledger. But first, some general tips:
|
||||
| | |
|
||||
|--------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| | |
|
||||
| [hledger-install.sh]<br><small>*Linux, Mac, WSL*</small> | <span style="font-size:medium;">**`curl -sO https://raw.githubusercontent.com/simonmichael/hledger/master/hledger-install/hledger-install.sh`**<br>**`less hledger-install.sh`** *# satisfy yourself that the script is safe*<br>**`bash hledger-install.sh`** *# runs stack or cabal, installing stack if needed*</span> |
|
||||
| [stack]<br><small>*Linux, Mac, Windows*</small> | <span style="font-size:medium;">**`stack install --resolver=nightly-2019-03-21 hledger hledger-web hledger-ui`**</span> *# installs GHC if needed.* |
|
||||
| [cabal]<br><small>*Linux, Mac, Windows*</small> | <span style="font-size:medium;">**`cabal v2-update && cabal v2-install hledger-1.14.2 hledger-web-1.14.1 hledger-ui-1.14.2`**</span> |
|
||||
|
||||
- Building Haskell programs involves downloading and building and
|
||||
optimising a lot of dependencies. If you haven't built Haskell
|
||||
software before, your first hledger build could take up to an
|
||||
hour, 1-2G of free memory, and 1-2G of disk.
|
||||
On Windows, hledger-ui is not available and should be omitted from the commands above (except, it probably works in WSL).
|
||||
|
||||
- Future builds will be much faster.
|
||||
#### Resource usage
|
||||
|
||||
- You can kill a build and restart it later without losing progress.
|
||||
Building Haskell programs typically involves downloading and compiling and
|
||||
optimising a lot of Haskell libraries.
|
||||
If you are doing it for the first time, know that building hledger could take
|
||||
1-2G of disk, 1-2G of free memory, and up to an hour (though usually it's much less).
|
||||
It's fine to kill a build and restart it later;
|
||||
and your later builds will be much faster.
|
||||
|
||||
- If you get link errors (eg: "/bin/ld.gold: error: cannot find -ltinfo"),
|
||||
you might need to install some extra system packages
|
||||
(C packages provided by your platform - not haskell packages)
|
||||
and try again. To find the right system package, check the list
|
||||
below, or do a web search for the error message (and please send
|
||||
updates for this list):
|
||||
|
||||
|
|
||||
|-----------------|-------------------------------------------------------------------
|
||||
| CentOS: | **`sudo yum install -y libstdc++-devel ncurses-devel zlib-devel`** <!-- https://github.com/simonmichael/hledger/issues/715 -->
|
||||
| Debian, Ubuntu: | **`sudo apt install -y libtinfo-dev`**
|
||||
| Fedora, RHEL: | **`sudo dnf install -y gmp-devel ncurses-devel`**
|
||||
|
||||
- <a name="build-issues"></a><a name="windows-build-issues"></a>Here are some known build issues and workarounds on certain platforms:
|
||||
|
||||
<span class=warnings>
|
||||
[windows: hledger-ui is not available](https://github.com/jtdaugherty/vty/pull/1#issuecomment-297143444)\
|
||||
[windows: build hangs using GHC 8.6.3](https://github.com/well-typed/generics-sop/issues/93)\
|
||||
[windows: cross-environment non-ascii display issues](https://github.com/simonmichael/hledger/issues/961#issuecomment-471229644)\
|
||||
[arch: haskell build advice from Arch wiki](https://wiki.archlinux.org/index.php/Haskell)\
|
||||
[arch: No information found for ghc-8.4.2](https://github.com/commercialhaskell/stack/issues/3984)\
|
||||
<!-- [arch: some past problems](https://github.com/simonmichael/hledger/issues/668) -->
|
||||
[freebsd 12: no cabal file found](https://github.com/simonmichael/hledger/issues/709)\
|
||||
[openbsd 6: exec permission denied](https://deftly.net/posts/2017-10-12-using-cabal-on-openbsd.html)\
|
||||
[openbsd: how to get stack](https://github.com/commercialhaskell/stack/issues/2822#issuecomment-318892816)\
|
||||
</span>
|
||||
|
||||
- If you have trouble, please send me a copy/paste of the output,
|
||||
including the commands you typed, at least up to the first error, via
|
||||
[paste](http://paste.hledger.org) + [IRC](http://irc.hledger.org),
|
||||
or the [issue tracker](http://bugs.hledger.org),
|
||||
or [email](index.html#helpfeedback).
|
||||
|
||||
|
||||
<a name="b1"></a>
|
||||
|
||||
### Building with hledger-install.sh
|
||||
|
||||
If you don't already have stack or cabal, or if you are having trouble with them,
|
||||
[hledger-install.sh](https://github.com/simonmichael/hledger/tree/master/hledger-install)
|
||||
is an easy and reliable way to get the latest hledger,
|
||||
on systems which have the bash shell (and are supported by GHC: mac, linux, unix-like environments on windows..).
|
||||
It automates the installation of stack or cabal and then building the hledger tools, avoiding common pitfalls.
|
||||
Here's how to run it (or, some folks will prefer to pipe it directly into bash):
|
||||
|
||||
**`curl -s https://raw.githubusercontent.com/simonmichael/hledger/master/hledger-install/hledger-install.sh > hledger-install.sh`**\
|
||||
**`less hledger-install.sh`** *# satisfy yourself that the script is safe*\
|
||||
**`bash hledger-install.sh`**
|
||||
|
||||
<a name="b2"></a>
|
||||
|
||||
### Building with stack
|
||||
|
||||
[`stack`](http://haskell-lang.org/get-started) is the more reliable of Haskell's two build tools for new users.
|
||||
You need stack 1.7.1 or newer; the latest release (eg 1.9.3) is the most reliable.
|
||||
You can often run `stack upgrade` to upgrade it.
|
||||
64-bit Windows users should choose the 64-bit version of stack.
|
||||
The following command installs the main hledger packages;
|
||||
|
||||
**`stack install --resolver=nightly-2019-03-21 hledger hledger-web hledger-ui`**\
|
||||
<!--
|
||||
**`hledger-ui-1.14.2 brick-0.46 text-zipper-0.10.1 config-ini-0.2.4.0 data-clist-0.1.2.2 word-wrap-0.4.1`**\
|
||||
-->
|
||||
|
||||
If needed, you can save some time by omitting the
|
||||
If needed, you can save time/memory/disk space by omitting the
|
||||
[hledger-web](http://hackage.haskell.org/package/hledger-web) and
|
||||
[hledger-ui](http://hackage.haskell.org/package/hledger-ui) packages
|
||||
(and hledger-ui's extra dependencies: brick, text-zipper, config-ini etc.)
|
||||
On Windows, hledger-ui is not available.
|
||||
from the stack or cabal commands above.
|
||||
To estimate the build time remaining, add `--dry-run`.
|
||||
|
||||
#### Using stack
|
||||
|
||||
The latest release of stack (eg 1.9.3) will be the most reliable and is recommended.
|
||||
If you have an older version, you can probably run `stack upgrade` to upgrade it.
|
||||
1.7.1 is the oldest that will work.
|
||||
On Windows, the 64-bit version of stack is recommended.
|
||||
|
||||
<!--
|
||||
Some other [add-on tools](/hledger.html#third-party-add-ons) like
|
||||
[hledger-api](http://hackage.haskell.org/package/hledger-api),
|
||||
[hledger-iadd](http://hackage.haskell.org/package/hledger-iadd),
|
||||
@ -199,25 +153,53 @@ and [hledger-interest](http://hackage.haskell.org/package/hledger-interest)
|
||||
can be installed like so:
|
||||
|
||||
**`stack install --resolver=nightly-2019-03-21 hledger-api hledger-interest hledger-iadd`**\
|
||||
<!--
|
||||
**`hledger-interest-1.5.3 hledger-iadd-1.3.9 brick-0.46 text-zipper-0.10.1 config-ini-0.2.4.0 data-clist-0.1.2.2 word-wrap-0.4.1`**\
|
||||
-->
|
||||
|
||||
<a name="b3"></a>
|
||||
<!-- <a name="b3"></a> -->
|
||||
|
||||
### Building with cabal
|
||||
<!-- #### cabal -->
|
||||
|
||||
[cabal](https://www.haskell.org/cabal/) is the other Haskell build tool. If you're a cabal expert, use it in the usual way, eg:
|
||||
#### C libraries may be required
|
||||
|
||||
**`cabal v2-update`**\
|
||||
**`cabal v2-install hledger-1.14.2 hledger-ui-1.14.2 hledger-web-1.14.1 hledger-api-1.14 \`**\
|
||||
**`hledger-iadd-1.3.9 hledger-interest-1.5.3`**\
|
||||
A few C libraries, like terminfo, are required but not installed by the commands above.
|
||||
When such C libs are missing, the build will fail at the end with a link error
|
||||
such as "/bin/ld.gold: error: cannot find -ltinfo".
|
||||
To solve this, just install the appropriate system package(s) and run the build command again.
|
||||
|
||||
### Set up PATH
|
||||
These package names vary by platform. If you don't see your platform below,
|
||||
do a web search for the link error message (and send updates for this list):
|
||||
|
||||
|
|
||||
|-----------------|-------------------------------------------------------------------
|
||||
|
|
||||
| Debian, Ubuntu: | **`sudo apt install -y libtinfo-dev`**
|
||||
| Fedora, RHEL: | **`sudo dnf install -y gmp-devel ncurses-devel`**
|
||||
<!-- | CentOS: | **`sudo yum install -y libstdc++-devel ncurses-devel zlib-devel`** --> <!-- https://github.com/simonmichael/hledger/issues/715 -->
|
||||
|
||||
<a name="build-issues"></a><a name="windows-build-issues"></a>
|
||||
|
||||
#### Platform-specific build issues
|
||||
|
||||
Here are some known build issues and workarounds on certain platforms:
|
||||
|
||||
<span class="warnings" style="font-size:medium;">
|
||||
[windows: hledger-ui is not available](https://github.com/jtdaugherty/vty/pull/1#issuecomment-297143444)\
|
||||
[windows: build hangs using GHC 8.6.3](https://github.com/well-typed/generics-sop/issues/93)\
|
||||
[windows: cross-environment non-ascii display issues](https://github.com/simonmichael/hledger/issues/961#issuecomment-471229644)\
|
||||
[arch: haskell build advice from Arch wiki](https://wiki.archlinux.org/index.php/Haskell)\
|
||||
[arch: No information found for ghc-8.4.2](https://github.com/commercialhaskell/stack/issues/3984)\
|
||||
<!-- [arch: some past problems](https://github.com/simonmichael/hledger/issues/668) -->
|
||||
[freebsd 12: no cabal file found](https://github.com/simonmichael/hledger/issues/709)\
|
||||
[openbsd 6: exec permission denied](https://deftly.net/posts/2017-10-12-using-cabal-on-openbsd.html)\
|
||||
[openbsd: how to get stack](https://github.com/commercialhaskell/stack/issues/2822#issuecomment-318892816)\
|
||||
</span>
|
||||
|
||||
#### Setting $PATH may be required
|
||||
|
||||
After building you may see a message about where the executables were installed.
|
||||
After installation, make sure this install directory is configured in your shell's \$PATH
|
||||
(preferably near the start of it, to preempt older hledger system packages you may have installed).
|
||||
(preferably near the start of it, in case you have older hledger binaries lying around).
|
||||
The install directory is:
|
||||
|
||||
| | on non-Windows systems | on Windows
|
||||
@ -230,9 +212,10 @@ If you are using bash, this should take care of it:
|
||||
|
||||
**`echo "export PATH=~/.local/bin:~/.cabal/bin:$PATH" >> ~/.bashrc && source ~/.bashrc`**
|
||||
|
||||
### Test the installation
|
||||
#### Test the installation
|
||||
|
||||
You should now be able to run the hledger tools (whichever ones you installed) and see the expected versions:
|
||||
After a successful build and install, you should be able to run the
|
||||
hledger tools (whichever ones you installed) and see the expected versions:
|
||||
|
||||
`$`**`hledger --version`**\
|
||||
`hledger 1.14.2`\
|
||||
|
||||
Loading…
Reference in New Issue
Block a user