From 00f5ddf0b8b2a9947b4ece77d3dbd6092e590367 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Tue, 11 Nov 2014 07:13:36 -0800 Subject: [PATCH] site: misc updates --- doc/developer-guide.md | 17 +++++++---------- doc/site/download.md | 2 +- doc/site/index.md | 23 ++++++++++++++--------- doc/site/installing.md | 26 +++++++++----------------- doc/site/release-notes.md | 1 + doc/site/step-by-step.md | 2 +- 6 files changed, 33 insertions(+), 38 deletions(-) diff --git a/doc/developer-guide.md b/doc/developer-guide.md index 5fd50160f..bb6595cb3 100644 --- a/doc/developer-guide.md +++ b/doc/developer-guide.md @@ -8,7 +8,6 @@ @@ -21,12 +20,12 @@ tr { | hledger-web demo | [demo.hledger.org](http://demo.hledger.org) | | Trello | [planning board](http://hledger.org/trello) | | Github | [code](http://github.com/simonmichael/hledger), [commits](http://github.com/simonmichael/hledger/commits), [COMMITS](http://starlogs.net/#simonmichael/hledger) (turn up your volume)
[commits only in master](https://github.com/simonmichael/hledger/compare/0.23...master), [commits only in release branch](https://github.com/simonmichael/hledger/compare/master...0.23)
[build status (hydra)](http://hydra.cryp.to/jobset/hledger/master#tabs-jobs)
[open bugs](https://github.com/simonmichael/hledger/issues?direction=desc&labels=BUG&page=1&sort=created&state=open), [all bugs](https://github.com/simonmichael/hledger/issues?direction=desc&labels=BUG&page=1&sort=created), [open issues](https://github.com/simonmichael/hledger/issues?direction=desc&labels=&page=1&sort=created&state=open), [all issues](https://github.com/simonmichael/hledger/issues?direction=desc&labels=&page=1&sort=created) | -| Hackage | [hledger-lib](http://hackage.haskell.org/package/hledger-lib), [hledger](http://hackage.haskell.org/package/hledger), [hledger-web](http://hackage.haskell.org/package/hledger-web), [hledger-interest](http://hackage.haskell.org/package/hledger-interest), [hledger-irr](http://hackage.haskell.org/package/hledger-irr), [hledger-vty](http://hackage.haskell.org/package/hledger-vty), [hledger-chart](http://hackage.haskell.org/package/hledger-chart), [*hledger*](http://hackage.haskell.org/packages/search?terms=hledger)
reverse dependencies: [hledger-lib](http://packdeps.haskellers.com/reverse/hledger-lib), [hledger](http://packdeps.haskellers.com/reverse/hledger), [outdated dependencies](http://packdeps.haskellers.com/feed/?needle=hledger)
[download activity](http://best-haskell.herokuapp.com/#/category/Finance) | +| Hackage | [hledger-lib](http://hackage.haskell.org/package/hledger-lib), [hledger](http://hackage.haskell.org/package/hledger), [hledger-web](http://hackage.haskell.org/package/hledger-web), [hledger-interest](http://hackage.haskell.org/package/hledger-interest), [hledger-irr](http://hackage.haskell.org/package/hledger-irr), [hledger-vty](http://hackage.haskell.org/package/hledger-vty), [hledger-chart](http://hackage.haskell.org/package/hledger-chart), [\*hledger\*](http://hackage.haskell.org/packages/search?terms=hledger)
reverse dependencies: [hledger-lib](http://packdeps.haskellers.com/reverse/hledger-lib), [hledger](http://packdeps.haskellers.com/reverse/hledger), [outdated dependencies](http://packdeps.haskellers.com/feed/?needle=hledger)
[download stats](http://best-haskell.herokuapp.com/#/category/Finance) | | Stackage | [hledger entry](https://github.com/fpco/stackage/blob/master/Stackage/Config.hs#L449-450), [issues](https://github.com/fpco/stackage/search?q=hledger&ref=cmdform&type=Issues)
[build status (jenkins)](http://jenkins.stackage.org/job/Stackage/), last build output: [7.4](http://jenkins.stackage.org/job/Stackage/ghcversion=7.4.2/lastBuild/console), [7.6](http://jenkins.stackage.org/job/Stackage/ghcversion=7.6.3/lastBuild/console), [7.8](http://jenkins.stackage.org/job/Stackage/ghcversion=7.8.2/lastBuild/console) | -| Debian | source packages
[haskell-hledger-lib](http://packages.qa.debian.org/h/haskell-hledger-lib.html), [bugs](https://bugs.debian.org/cgi-bin/pkgreport.cgi?package=haskell-hledger-lib), [haskell-hledger](http://packages.qa.debian.org/h/haskell-hledger.html), [bugs](https://bugs.debian.org/cgi-bin/pkgreport.cgi?package=haskell-hledger), [haskell-hledger-web](http://packages.qa.debian.org/h/haskell-hledger-web.html), [bugs](https://bugs.debian.org/cgi-bin/pkgreport.cgi?package=haskell-hledger-web)
binary packages
testing: [hledger](https://packages.debian.org/testing/hledger), [bugs](https://bugs.debian.org/cgi-bin/pkgreport.cgi?package=hledger;dist=testing), [hledger-web](https://packages.debian.org/testing/hledger-web), [bugs](https://bugs.debian.org/cgi-bin/pkgreport.cgi?package=hledger-web;dist=testing)
unstable: [hledger](https://packages.debian.org/unstable/hledger), [bugs](https://bugs.debian.org/cgi-bin/pkgreport.cgi?package=hledger;dist=unstable), [hledger-web](https://packages.debian.org/unstable/hledger-web), [bugs](https://bugs.debian.org/cgi-bin/pkgreport.cgi?package=hledger-web;dist=unstable)
all: [*hledger*](https://packages.debian.org/search?searchon=names&keywords=hledger)
popularity stats: [hledger](https://qa.debian.org/popcon.php?package=haskell-hledger), [hledger-web](https://qa.debian.org/popcon.php?package=haskell-hledger-web)
[PTS help](https://www.debian.org/doc/manuals/developers-reference/resources.html#pkg-tracking-system) | -| Ubuntu | source packages
[haskell-hledger-lib](https://launchpad.net/ubuntu/+source/haskell-hledger-lib), [bugs](https://bugs.launchpad.net/ubuntu/+source/haskell-hledger-lib), [haskell-hledger](https://launchpad.net/ubuntu/+source/haskell-hledger), [bugs](https://bugs.launchpad.net/ubuntu/+source/haskell-hledger), [haskell-hledger-web](https://launchpad.net/ubuntu/+source/haskell-hledger-web), [bugs](https://bugs.launchpad.net/ubuntu/+source/haskell-hledger-web)
binary packages
[*hledger*](http://packages.ubuntu.com/search?suite=all&searchon=names&keywords=hledger) | -| Gentoo | [hledger](http://gpo.zugaina.org/dev-haskell/hledger), [hledger-web](http://gpo.zugaina.org/dev-haskell/hledger-web), [*hledger*](http://gpo.zugaina.org/Search?search=hledger) | -| Fedora | [hledger](https://apps.fedoraproject.org/packages/hledger), [*hledger*](https://apps.fedoraproject.org/packages/s/hledger) | +| Debian | source packages
[haskell-hledger-lib](http://packages.qa.debian.org/h/haskell-hledger-lib.html), [bugs](https://bugs.debian.org/cgi-bin/pkgreport.cgi?package=haskell-hledger-lib), [haskell-hledger](http://packages.qa.debian.org/h/haskell-hledger.html), [bugs](https://bugs.debian.org/cgi-bin/pkgreport.cgi?package=haskell-hledger), [haskell-hledger-web](http://packages.qa.debian.org/h/haskell-hledger-web.html), [bugs](https://bugs.debian.org/cgi-bin/pkgreport.cgi?package=haskell-hledger-web)
binary packages
testing: [hledger](https://packages.debian.org/testing/hledger), [bugs](https://bugs.debian.org/cgi-bin/pkgreport.cgi?package=hledger;dist=testing), [hledger-web](https://packages.debian.org/testing/hledger-web), [bugs](https://bugs.debian.org/cgi-bin/pkgreport.cgi?package=hledger-web;dist=testing)
unstable: [hledger](https://packages.debian.org/unstable/hledger), [bugs](https://bugs.debian.org/cgi-bin/pkgreport.cgi?package=hledger;dist=unstable), [hledger-web](https://packages.debian.org/unstable/hledger-web), [bugs](https://bugs.debian.org/cgi-bin/pkgreport.cgi?package=hledger-web;dist=unstable)
all: [\*hledger\*](https://packages.debian.org/search?searchon=names&keywords=hledger)
popularity stats: [hledger](https://qa.debian.org/popcon.php?package=haskell-hledger), [hledger-web](https://qa.debian.org/popcon.php?package=haskell-hledger-web)
[PTS help](https://www.debian.org/doc/manuals/developers-reference/resources.html#pkg-tracking-system) | +| Ubuntu | source packages
[haskell-hledger-lib](https://launchpad.net/ubuntu/+source/haskell-hledger-lib), [bugs](https://bugs.launchpad.net/ubuntu/+source/haskell-hledger-lib), [haskell-hledger](https://launchpad.net/ubuntu/+source/haskell-hledger), [bugs](https://bugs.launchpad.net/ubuntu/+source/haskell-hledger), [haskell-hledger-web](https://launchpad.net/ubuntu/+source/haskell-hledger-web), [bugs](https://bugs.launchpad.net/ubuntu/+source/haskell-hledger-web)
binary packages
[\*hledger\*](http://packages.ubuntu.com/search?suite=all&searchon=names&keywords=hledger) | +| Gentoo | [hledger](http://gpo.zugaina.org/dev-haskell/hledger), [hledger-web](http://gpo.zugaina.org/dev-haskell/hledger-web), [\*hledger\*](http://gpo.zugaina.org/Search?search=hledger) | +| Fedora | [hledger](https://apps.fedoraproject.org/packages/hledger), [\*hledger\*](https://apps.fedoraproject.org/packages/s/hledger) | ---- - ## Project overview A rough overview/blueprint for the hledger project. @@ -117,8 +114,8 @@ These should probably not be updated directly, instead they are copied from the ### Code -The hledger repo is hosted on github.com: http://github.com/simonmichael/hledger. -(You can also jump there via [hledger.org/code[/commits]](http://hledger.org/code), or code.hledger.org[/commits]). +The hledger repo is hosted on Github, at http://github.com/simonmichael/hledger. +You can also jump there via hledger.org/code[/commits] or code.hledger.org[/commits]. ### Quality control diff --git a/doc/site/download.md b/doc/site/download.md index 9052e88ad..015369d5b 100644 --- a/doc/site/download.md +++ b/doc/site/download.md @@ -63,7 +63,7 @@ it's demand-driven - you can indicate demand by making a project donation of any size. Binaries funded in this way will be linked here. This is a quick way to help the project and your fellow users! -## I want to build the [latest release](http://hackage.haskell.org/package/hledger-web) with [GHC](http://haskell.org/haskell) and [cabal](http://haskell.org/cabal/download.html) +## I want to build the [latest release](http://hackage.haskell.org/package/hledger-web) with [GHC](http://haskell.org/ghc) and [cabal](http://haskell.org/cabal/download.html) `cabal sandbox init; cabal update; cabal install hledger[-web]`\ diff --git a/doc/site/index.md b/doc/site/index.md index aa2764c31..755eb3fb3 100644 --- a/doc/site/index.md +++ b/doc/site/index.md @@ -5,19 +5,24 @@ hledger is a computer program for easily tracking money, time, or other commodities, on unix, mac and windows. It was inspired by and maintains substantial compatibility with [Ledger](faq.html#hledger-and-ledger). -hledger is first a command-line tool, but there is also a [web interface](manual.html#web), -and a [Haskell library](http://hackage.haskell.org/package/hledger-lib) for -building your own programs and [scripts](more-docs.html#scripting-examples) +hledger is first a command-line tool, but there is also a +web interface, + +and a +Haskell library + +for building your own programs and +scripts + (hledger is written in Haskell). hledger is free software, available under the GNU GPLv3+, created by [Simon Michael](http://joyful.com) and [contributors](contributors.html). -Though limited in features, hledger is lightweight, usable and reliable. -For some, it is a simple, flexible, future-proof alternative to Quicken or GnuCash. -It aims to help both computer experts and regular folks -to gain clarity and control in their finances and time management, -but currently it is a bit more suited to techies. -I've been using (and improving) it since 2007 to: +hledger aims to help both computer experts and regular folks gain more clarity and control over their time and money +(but currently it is a bit more suited to techies). +Despite its limited GUI, hledger is usable, capable and reliable. +For some of us, it is a simple, flexible, future-proof alternative to Quicken or GnuCash. +I've been using and improving it continuously since 2007, using it to: - track spending and income - see time reports by day/week/month/project diff --git a/doc/site/installing.md b/doc/site/installing.md index 8f651be85..9890b7093 100644 --- a/doc/site/installing.md +++ b/doc/site/installing.md @@ -2,9 +2,6 @@ # Installation Guide -- [[#How to install]] -- [[#Troubleshooting]] - ## How to install hledger works on GNU/linux, mac and windows. @@ -15,21 +12,15 @@ Here are several ways to install it: If you have a system package manager that includes hledger, this will be the quickest and easiest way to install, if you don't need the very latest version. - -^ On distro/packaging system: ^ Run: ^ -| Debian & Ubuntu: | `apt-get install hledger [hledger-web]` | -| Red Hat, Fedora & CentOS (?): | `yum install hledger` | -| NixOS: | `nix-env -iA nixpkgs.haskellPackages.hledger` | +These are listed on [Download](download.html). ### b. Download binaries from hledger.org -Ready-to-run [[download|downloads]] for GNU/Linux, Mac OSX, and -Microsoft Windows are provided on a donation basis. These have not -been updated recently, but you can fix that by making a donation of -any size (see the page for more). - -These are simple compressed executables (not installers), so after downloading -you may need to decompress, adjust permissions, and rename the file. Eg: +Ready-to-run binaries for GNU/Linux, Mac OSX, and Microsoft Windows +are provided on a donation basis ([Download](download.html)). These +are simple compressed executables (not installers), so after +downloading you may need to decompress, adjust permissions, and rename +the file. Eg: $ gunzip hledger-web-0.18.2-mac-x86_64.gz $ chmod +x hledger-web-0.18.2-mac-x86_64 @@ -45,13 +36,14 @@ use the troubleshooting tips below if needed. Ensure you have [GHC](http://haskell.org/ghc) or the [Haskell Platform](http://haskell.org/platform) installed. -hledger requires GHC 7.2 or greater, and hledger-web requires GHC 7.4 or greater. +Last time we checked, hledger requires GHC 7.2 or greater, and hledger-web requires GHC 7.4 or greater. +But using the current or previous major GHC version will very likely be easiest. Also note that some Haskell packages depend on C packages, and cabal currently isn't able to install or identify those for you. A common issue is not having all the ncurses C libraries installed. A quick way to ensure you have all required C libs is to -[install hledger once with your system package manager](#install-with-your-system-package-manager) +install hledger [with your system package manager](#a.-with-your-system-package-manager) before installing the latest version with cabal. Then install the hledger command-line tool: diff --git a/doc/site/release-notes.md b/doc/site/release-notes.md index ab882e312..48e0566ab 100644 --- a/doc/site/release-notes.md +++ b/doc/site/release-notes.md @@ -7,6 +7,7 @@ Based on the [hledger-web](http://hackage.haskell.org/package/hledger-web/changelog) & [hledger-lib](http://hackage.haskell.org/package/hledger-lib/changelog) change logs. + ## hledger-web 0.23.3 (2014/9/12) - remove warp, wai-handler-launch upper bounds (fixes #205) diff --git a/doc/site/step-by-step.md b/doc/site/step-by-step.md index 3eb569b7f..222e21bbf 100644 --- a/doc/site/step-by-step.md +++ b/doc/site/step-by-step.md @@ -21,7 +21,7 @@ You'll need: ## SETUP -### Check your hledger +### Check your hledger installation Get a command prompt, and run hledger to check the version. It should be reasonably [up to date](release-notes.html):