diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 31 |
1 files changed, 28 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e810e7df..79e97296 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,9 @@ Tips for contributors --------------------- -* Please **make pull requests against `next`, not `master`**. - Ledger follows a [git-flow] branching model, - in which development happens on the `next` branch and is subsequently merged into `master` for releases. +* Please **make pull requests against `next`, not `master`**. Ledger follows + a [git-flow] branching model, in which development happens on the `next` + branch and is subsequently merged into `master` for releases. * If you're making **changes to files for which the Travis build is not relevant**, please **add `[ci skip]` to the end of the commit message**. * Report bugs using [Bugzilla]. If you want, you can access the bug system using the lite (free) version of [Deskzilla]. @@ -92,6 +92,31 @@ orientation: **./tools/**: an accretion of tools, mostly small scripts, to aid development +Building +--- + +If you are going to be working on Ledger, you'll want to enable both debug +builds (which are the default, using `acprep`), and also the use of +pre-compiled headers. To do this, specify your compiler as either `clang++` +or `g++` as follows: + + mkdir build + ./acprep --compiler=clang++ + cd build + make + +This will set up a debug build using clang++ (and pre-compiled headers, which +is enabled by the combination of those two), and then start a build. + +For even quicker rebuilds, try the Ninja build tool, which is very fast at +determining what to rebuild, and automatically takes advantage of multiple +cores: + + mkdir build + ./acprep --compiler=clang++ --ninja + cd build + ninja + [Boost]: http://boost.org [Boost.Python]: http://www.boost.org/libs/python/ [Bugzilla]: http://bugs.ledger-cli.org/ |