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

site: dev -> quick links layout

Browse Source
This commit is contained in:
Simon Michael 2011-06-24 03:38:00 +00:00
parent 214b232dd7
commit 5f3388ce0a
1 changed files with 31 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
DEVELOPMENT.md
View File

@ -4,47 +4,52 @@ title: hledger developers' guide
# Developers' guide # Developers' guide
A rough guide for hledger contributors of all kinds, plus some quick links for everyone. Quick links for everyone, plus a rough guide mostly for hledger
contributors and developers.
<a name="support" /> <a name="support" />
## Quick links ## Quick links
- User and developer support: [how to get help](#how-to-get-help) **Support**<br>
- IRC channel: [irc://irc.freenode.net/#ledger](irc://irc.freenode.net/#ledger) Users and developers: [how to get help](#how-to-get-help)
- Mail list: [http://list.hledger.org](http://list.hledger.org) <br>IRC channel: [irc.freenode.net/#ledger](irc://irc.freenode.net/#ledger)
- Bug tracker: [http://bugs.hledger.org](http://bugs.hledger.org) <br>Mail list: [list.hledger.org](http://list.hledger.org)
- [Release notes](NEWS.html) <br>Bug tracker: [bugs.hledger.org](http://bugs.hledger.org)
- Code:
[get it](#how-to-set-up-for-hledger-development), **Released version**<br>
[browse it](http://joyful.com/darcsweb/darcsweb.cgi?r=hledger), [Release notes](NEWS.html)<br>
[latest api docs](http://hledger.org/api-doc),
[latest internal code docs](http://hledger.org/code-doc) for all packages
- Packages:
[hledger](http://hackage.haskell.org/package/hledger), [hledger](http://hackage.haskell.org/package/hledger),
[hledger-lib](http://hackage.haskell.org/package/hledger-lib), [hledger-web](http://hackage.haskell.org/package/hledger-web),
[hledger-chart](http://hackage.haskell.org/package/hledger-chart),
[hledger-vty](http://hackage.haskell.org/package/hledger-vty), [hledger-vty](http://hackage.haskell.org/package/hledger-vty),
[hledger-web](http://hackage.haskell.org/package/hledger-web) [hledger-chart](http://hackage.haskell.org/package/hledger-chart),
- Developer reports: [hledger-lib](http://hackage.haskell.org/package/hledger-lib)
<script type="text/javascript" src="http://haskell.org/hoogle/datadir/resources/jquery-1.4.2.js"></script>
<script type="text/javascript" src="http://haskell.org/hoogle/datadir/resources/hoogle.js"></script>
<form action="http://haskell.org/hoogle/" method="get" style="display:inline; margin:0; padding:0;">
<input type="hidden" name="prefix" value="+hledger +hledger-lib +hledger-web +hledger-vty +hledger-chart" />
**Latest development version**<br>
[get it](#how-to-set-up-for-hledger-development),
[browse it](http://joyful.com/darcsweb/darcsweb.cgi?r=hledger)
<br>[external API haddocks](http://hledger.org/api-doc)
<input type="text" name="hoogle" id="hoogle" accesskey="1"
/><input type="submit" value="search"
/>&nbsp;(if you are scripting or using hledger in another app)
<br>[internal code haddocks](http://hledger.org/code-doc)
<br>&nbsp;(if you are learning/developing hledger's internals)
<br>[Developer notes](http://joyful.com/darcsweb/darcsweb.cgi?r=hledger;a=plainblob;f=/NOTES),
[haddock coverage](http://hledger.org/profs/haddock-coverage), [haddock coverage](http://hledger.org/profs/haddock-coverage),
[unit test coverage](http://hledger.org/profs/coverage/hpc_index_fun.html), [unit test coverage](http://hledger.org/profs/coverage/hpc_index_fun.html),
[benchmark](http://hledger.org/profs/latest.bench), [benchmark](http://hledger.org/profs/latest.bench),
[profile](http://hledger.org/profs/latest.prof), [profile](http://hledger.org/profs/latest.prof),
[heap](http://hledger.org/profs/latest.ps) [heap](http://hledger.org/profs/latest.ps)
- [Developer notes](http://joyful.com/darcsweb/darcsweb.cgi?r=hledger;a=plainblob;f=/NOTES)
<!-- [hledger dependencies](http://packdeps.haskellers.com/feed/?needle=hledger), --> <!-- [hledger dependencies](http://packdeps.haskellers.com/feed/?needle=hledger), -->
<!-- [hledger-lib dependencies](http://packdeps.haskellers.com/feed/?needle=hledger-lib), --> <!-- [hledger-lib dependencies](http://packdeps.haskellers.com/feed/?needle=hledger-lib), -->
<!-- [hledger-chart dependencies](http://packdeps.haskellers.com/feed/?needle=hledger-chart), --> <!-- [hledger-chart dependencies](http://packdeps.haskellers.com/feed/?needle=hledger-chart), -->
<!-- [hledger-vty dependencies](http://packdeps.haskellers.com/feed/?needle=hledger-vty), --> <!-- [hledger-vty dependencies](http://packdeps.haskellers.com/feed/?needle=hledger-vty), -->
<!-- [hledger-web dependencies](http://packdeps.haskellers.com/feed/?needle=hledger-web) --> <!-- [hledger-web dependencies](http://packdeps.haskellers.com/feed/?needle=hledger-web) -->
reports
<script type="text/javascript" src="http://haskell.org/hoogle/datadir/resources/jquery-1.4.2.js"></script>
<script type="text/javascript" src="http://haskell.org/hoogle/datadir/resources/hoogle.js"></script>
<form action="http://haskell.org/hoogle/" method="get">
<input type="text" name="hoogle" id="hoogle" accesskey="1" size="80" />
<input type="hidden" name="prefix" value="+hledger +hledger-lib +hledger-web +hledger-vty +hledger-chart" />
<input type="submit" value="Search API of all hledger packages" />
</form> </form>
## How to.. ## How to..
@ -58,8 +63,8 @@ A rough guide for hledger contributors of all kinds, plus some quick links for e
- chat Simon (sm) on the - chat Simon (sm) on the
[\#ledger](irc://irc.freenode.net/#ledger) irc channel which we [\#ledger](irc://irc.freenode.net/#ledger) irc channel which we
share, or [send email](mailto:simon@joyful.com?subject=hledger:) share, or [send email](mailto:simon@joyful.com?subject=hledger:)
- for issues relevant to the wider *ledger community, you can also use or cc ledger's mail list - for issues relevant to the wider *ledger community, you can also use or cc [ledger's mail list](http://list.ledger-cli.org)
- don't forget the [installation tips](MANUAL.html#installing), [Troubleshooting](MANUAL.html#troubleshooting) section, and bug tracker - don't forget the [installation tips](MANUAL.html#installing), [Troubleshooting](MANUAL.html#troubleshooting) section, and [bug tracker](http://bugs.hledger.org)
### how to report problems ### how to report problems