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

doc: more download/devguide tweaks

Browse Source
This commit is contained in:
Simon Michael 2015-08-24 09:34:26 -07:00
parent ee8161dd1c
commit 9647d350b1
2 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/developer-guide.md
View File

@ -424,7 +424,7 @@ Summary (best iteration):
+-----------------------------------------++---------+ +-----------------------------------------++---------+
``` ```
bench's --simplebench mode is based on a standalone tool, tools/simplebench.hs. bench's --simplebench mode is based on a standalone tool, [tools/simplebench.hs](https://github.com/simonmichael/hledger/blob/master/tools/simplebench.hs).
simplebench.hs is a generic benchmarker of one or more executables (specified on the command line) against one or more sets of command-line arguments (specified in a file). simplebench.hs is a generic benchmarker of one or more executables (specified on the command line) against one or more sets of command-line arguments (specified in a file).
It has a better command-line interface than bench.hs, so you may find it more convenient It has a better command-line interface than bench.hs, so you may find it more convenient
for comparing multiple hledger versions, or hledger and ledger. Eg: for comparing multiple hledger versions, or hledger and ledger. Eg:
@ -477,6 +477,11 @@ Finally, for quick, fine-grained performance measurements when troubleshooting o
### Generate sample journal files ### Generate sample journal files
Synthetic data files like `data/100x100x10.journal` useful for benchmarks and testing.
The numbers describe the number of transactions, number of accounts, and maximum account depth respectively.
They are generated by [`tools/generatejournal.hs`](https://github.com/simonmichael/hledger/blob/master/tools/generatejournal.hs).
They should be built as needed, if not you can use `make samplejournals` rule:
```shell ```shell
$ make samplejournals $ make samplejournals
ghc tools/generatejournal.hs ghc tools/generatejournal.hs

2
doc/site/download.md
View File

@ -96,7 +96,7 @@ This is a quick way to help the project and your fellow users!
processing >50,000 transactions at a time with hledger, cf [#275](https://github.com/simonmichael/hledger/issues/275)). processing >50,000 transactions at a time with hledger, cf [#275](https://github.com/simonmichael/hledger/issues/275)).
2. `stack setup` 2. `stack setup`
(if you need GHC, eg on Windows. If you're not sure, run the next command and it will tell you.) (if you need GHC installed. If you're not sure, run the next command and it will tell you.)
3. `stack install hledger` (the command-line UI), or\ 3. `stack install hledger` (the command-line UI), or\
`stack install hledger-ui` (the terminal UI; not available on Windows; includes the above), or\ `stack install hledger-ui` (the terminal UI; not available on Windows; includes the above), or\