site: contributing: cleanup
This commit is contained in:
parent
80772cecff
commit
cf71c2e192
@ -1,12 +1,13 @@
|
|||||||
|
# Contributor guide
|
||||||
|
|
||||||
<style>
|
<style>
|
||||||
#toc > ol > li > a { display:none; }
|
#toc > ol > li > a { display:none; }
|
||||||
#toc > ol > li > ol > li { padding-left:0; }
|
#toc > ol > li > ol > li { padding-left:0; }
|
||||||
</style>
|
</style>
|
||||||
* toc
|
* toc
|
||||||
|
|
||||||
# Contributor guide
|
New contributors are always welcome in the hledger project.
|
||||||
|
Jump in! Or [ask us](/docs.html#getting-help) to help you find a task.
|
||||||
New contributors are always welcome. Jump in! Or [ask us](/docs.html#getting-help) to help you find a task.
|
|
||||||
|
|
||||||
|
|
||||||
## Get started as a...
|
## Get started as a...
|
||||||
@ -14,16 +15,17 @@ New contributors are always welcome. Jump in! Or [ask us](/docs.html#getting-hel
|
|||||||
### Funder
|
### Funder
|
||||||
|
|
||||||
Become a financial backer to
|
Become a financial backer to
|
||||||
help sustain the project,
|
sustain and grow this project,
|
||||||
influence issues you care about,
|
increase your influence,
|
||||||
express gratitude,
|
express gratitude,
|
||||||
build your prosperity consciousness!
|
build prosperity consciousness,
|
||||||
|
and help transform world finance!
|
||||||
|
|
||||||
- Use the donate links on the home page
|
- Use the donate links on the [home page](/)
|
||||||
- Configure a recurring donation
|
- Configure a recurring donation
|
||||||
- Contribute or pledge bounties on issues
|
- Contribute or pledge bounties on issues you care about
|
||||||
- Ask your organization to contribute
|
- Ask your organization to contribute
|
||||||
- Work on project sustainability and accountability
|
- Work on project sustainability, accountability, fundraising
|
||||||
|
|
||||||
### Tester
|
### Tester
|
||||||
|
|
||||||
@ -313,7 +315,7 @@ tools/generatejournal 3 5 5 --mixed >examples/mixed.journal
|
|||||||
|
|
||||||
In short: get [`stack`](/download.html#b) and (except on Windows, where stack provides it) [`git`](http://git-scm.com), then:
|
In short: get [`stack`](/download.html#b) and (except on Windows, where stack provides it) [`git`](http://git-scm.com), then:
|
||||||
|
|
||||||
`$ git clone http://github.com/simonmichael/hledger hledger && cd hledger && stack install # or git://...`
|
`$ git clone http://github.com/simonmichael/hledger hledger && cd hledger && stack install`
|
||||||
|
|
||||||
\
|
\
|
||||||
In more detail:
|
In more detail:
|
||||||
@ -353,18 +355,21 @@ $ stack install
|
|||||||
```
|
```
|
||||||
|
|
||||||
This builds all the hledger packages, and installs executables in
|
This builds all the hledger packages, and installs executables in
|
||||||
`$HOME/.local/bin` (or the Windows equivalent), which you should add
|
`$HOME/.local/bin/` (or the Windows equivalent), which you should
|
||||||
to your `$PATH`.
|
[add to your `$PATH`](/download.html#b).
|
||||||
|
|
||||||
You can build fewer packages to save time, eg just the CLI:
|
|
||||||
`stack install hledger`.
|
|
||||||
You can also build without installing executables: `stack build; stack exec -- hledger [ARGS]`.
|
|
||||||
|
|
||||||
Note stack fetches most required dependencies automatically,
|
Note stack fetches most required dependencies automatically,
|
||||||
but not C libraries such as curses or terminfo, which you might need
|
but not C libraries such as curses or terminfo, which you might need
|
||||||
to install yourself.
|
to install yourself, using your system's package manager.
|
||||||
In case of trouble, see [download](/download.html#b).
|
In case of trouble, see [download](/download.html#b).
|
||||||
|
|
||||||
|
Downloading and building can take a while!
|
||||||
|
You can build fewer [packages](/manual.html#official-add-ons) to save time (recommended). Eg to build just the CLI:\
|
||||||
|
`stack install hledger`
|
||||||
|
|
||||||
|
You can also build and run in place, without installing executables:\
|
||||||
|
`stack build; stack exec -- hledger [ARGS]`
|
||||||
|
|
||||||
|
|
||||||
#### Add a test
|
#### Add a test
|
||||||
|
|
||||||
|
|||||||
@ -1,3 +1,5 @@
|
|||||||
|
# User guide
|
||||||
|
|
||||||
<style>
|
<style>
|
||||||
h2 { font-size:x-large; margin-top:0.5em; }
|
h2 { font-size:x-large; margin-top:0.5em; }
|
||||||
h3 { font-size:large; margin-bottom:0.2em; }
|
h3 { font-size:large; margin-bottom:0.2em; }
|
||||||
@ -5,8 +7,6 @@ tr { border-top:thin solid #bbb; border-bottom:thin solid #bbb; vertical-align:t
|
|||||||
td:nth-child(1) { padding-right:1em; white-space:nowrap; }
|
td:nth-child(1) { padding-right:1em; white-space:nowrap; }
|
||||||
</style>
|
</style>
|
||||||
|
|
||||||
# User guide
|
|
||||||
|
|
||||||
<div class="container">
|
<div class="container">
|
||||||
|
|
||||||
## Get help
|
## Get help
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user