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

site: misc updates

Browse Source
This commit is contained in:
Simon Michael 2014-11-11 07:13:36 -08:00
parent deb6c74807
commit 00f5ddf0b8
6 changed files with 33 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/developer-guide.md
View File

@ -8,7 +8,6 @@
<style> <style>
tr { tr {
/*vertical-align:top;*/
border-top:thin solid #bbb; border-top:thin solid #bbb;
} }
</style> </style>
@ -21,12 +20,12 @@ tr {
| hledger-web demo | [demo.hledger.org](http://demo.hledger.org) | | hledger-web demo | [demo.hledger.org](http://demo.hledger.org) |
| Trello | [planning board](http://hledger.org/trello) | | 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) <br> [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) <br> [build status (hydra)](http://hydra.cryp.to/jobset/hledger/master#tabs-jobs) <br> [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) | | Github | [code](http://github.com/simonmichael/hledger), [commits](http://github.com/simonmichael/hledger/commits), [COMMITS](http://starlogs.net/#simonmichael/hledger) (turn up your volume) <br> [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) <br> [build status (hydra)](http://hydra.cryp.to/jobset/hledger/master#tabs-jobs) <br> [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) <br> 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) <br> [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) <br> 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) <br> [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) <br> [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) | | 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) <br> [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 <br> [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) <br> binary packages <br> 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) <br> 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) <br> all: [*hledger*](https://packages.debian.org/search?searchon=names&keywords=hledger) <br> popularity stats: [hledger](https://qa.debian.org/popcon.php?package=haskell-hledger), [hledger-web](https://qa.debian.org/popcon.php?package=haskell-hledger-web) <br> [PTS help](https://www.debian.org/doc/manuals/developers-reference/resources.html#pkg-tracking-system) | | Debian | source packages <br> [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) <br> binary packages <br> 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) <br> 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) <br> all: [\*hledger\*](https://packages.debian.org/search?searchon=names&keywords=hledger) <br> popularity stats: [hledger](https://qa.debian.org/popcon.php?package=haskell-hledger), [hledger-web](https://qa.debian.org/popcon.php?package=haskell-hledger-web) <br> [PTS help](https://www.debian.org/doc/manuals/developers-reference/resources.html#pkg-tracking-system) |
| Ubuntu | source packages <br> [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) <br> binary packages <br> [*hledger*](http://packages.ubuntu.com/search?suite=all&searchon=names&keywords=hledger) | | Ubuntu | source packages <br> [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) <br> binary packages <br> [\*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) | | 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) | | Fedora | [hledger](https://apps.fedoraproject.org/packages/hledger), [\*hledger\*](https://apps.fedoraproject.org/packages/s/hledger) |
<!-- list the debian packages for clarity: <!-- list the debian packages for clarity:
3 source: 3 source:
@ -68,8 +67,6 @@ libghc-hledger-lib-prof
--> -->
---
## Project overview ## Project overview
A rough overview/blueprint for the hledger project. 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 ### Code
The hledger repo is hosted on github.com: http://github.com/simonmichael/hledger. The hledger repo is hosted on Github, at http://github.com/simonmichael/hledger.
(You can also jump there via [hledger.org/code[/commits]](http://hledger.org/code), or code.hledger.org[/commits]). You can also jump there via hledger.org/code[/commits] or code.hledger.org[/commits].
### Quality control ### Quality control

2
doc/site/download.md
View File

@ -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. 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! 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]`\ `cabal sandbox init; cabal update; cabal install hledger[-web]`\
<!-- [cabal install guide](cabal-install.html) --> <!-- [cabal install guide](cabal-install.html) -->

23
doc/site/index.md
View File

@ -5,19 +5,24 @@
hledger is a computer program for easily tracking money, time, or other commodities, hledger is a computer program for easily tracking money, time, or other commodities,
on unix, mac and windows. on unix, mac and windows.
It was inspired by and maintains substantial compatibility with [Ledger](faq.html#hledger-and-ledger). 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), hledger is first a command-line tool, but there is also a
and a [Haskell library](http://hackage.haskell.org/package/hledger-lib) for web interface,
building your own programs and [scripts](more-docs.html#scripting-examples) <!-- [web interface](manual.html#web), -->
and a
Haskell library
<!-- [Haskell library](http://hackage.haskell.org/package/hledger-lib) -->
for building your own programs and
scripts
<!-- [scripts](more-docs.html#scripting-examples) -->
(hledger is written in Haskell). (hledger is written in Haskell).
hledger is free software, available under the GNU GPLv3+, hledger is free software, available under the GNU GPLv3+,
created by [Simon Michael](http://joyful.com) and [contributors](contributors.html). created by [Simon Michael](http://joyful.com) and [contributors](contributors.html).
Though limited in features, hledger is lightweight, usable and reliable. hledger aims to help both computer experts and regular folks gain more clarity and control over their time and money
For some, it is a simple, flexible, future-proof alternative to Quicken or GnuCash. (but currently it is a bit more suited to techies).
It aims to help both computer experts and regular folks Despite its limited GUI, hledger is usable, capable and reliable.
to gain clarity and control in their finances and time management, For some of us, it is a simple, flexible, future-proof alternative to Quicken or GnuCash.
but currently it is a bit more suited to techies. I've been using and improving it continuously since 2007, using it to:
I've been using (and improving) it since 2007 to:
- track spending and income - track spending and income
- see time reports by day/week/month/project - see time reports by day/week/month/project

26
doc/site/installing.md
View File

@ -2,9 +2,6 @@
# Installation Guide # Installation Guide
- [[#How to install]]
- [[#Troubleshooting]]
## How to install ## How to install
hledger works on GNU/linux, mac and windows. 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, If you have a system package manager that includes hledger,
this will be the quickest and easiest way to install, this will be the quickest and easiest way to install,
if you don't need the very latest version. if you don't need the very latest version.
These are listed on [Download](download.html).
^ 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` |
### b. Download binaries from hledger.org ### b. Download binaries from hledger.org
Ready-to-run [[download|downloads]] for GNU/Linux, Mac OSX, and Ready-to-run binaries for GNU/Linux, Mac OSX, and Microsoft Windows
Microsoft Windows are provided on a donation basis. These have not are provided on a donation basis ([Download](download.html)). These
been updated recently, but you can fix that by making a donation of are simple compressed executables (not installers), so after
any size (see the page for more). downloading you may need to decompress, adjust permissions, and rename
the file. Eg:
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 $ gunzip hledger-web-0.18.2-mac-x86_64.gz
$ chmod +x hledger-web-0.18.2-mac-x86_64 $ 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 Ensure you have [GHC](http://haskell.org/ghc) or
the [Haskell Platform](http://haskell.org/platform) installed. 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 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 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 issue is not having all the ncurses C libraries installed. A quick way
to ensure you have all required C libs is to 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. before installing the latest version with cabal.
Then install the hledger command-line tool: Then install the hledger command-line tool:

1
doc/site/release-notes.md
View File

@ -7,6 +7,7 @@ Based on the
[hledger-web](http://hackage.haskell.org/package/hledger-web/changelog) & [hledger-web](http://hackage.haskell.org/package/hledger-web/changelog) &
[hledger-lib](http://hackage.haskell.org/package/hledger-lib/changelog) [hledger-lib](http://hackage.haskell.org/package/hledger-lib/changelog)
change logs. change logs.
## hledger-web 0.23.3 (2014/9/12) ## hledger-web 0.23.3 (2014/9/12)
- remove warp, wai-handler-launch upper bounds (fixes #205) - remove warp, wai-handler-launch upper bounds (fixes #205)

2
doc/site/step-by-step.md
View File

@ -21,7 +21,7 @@ You'll need:
## SETUP ## 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): Get a command prompt, and run hledger to check the version. It should be reasonably [up to date](release-notes.html):