diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 156 |
1 files changed, 88 insertions, 68 deletions
@@ -21,44 +21,36 @@ and easy to use. I know, you just want to build and play. If you have all the dependencies installed (see below), then simply do this: - git clone git://github.com/ledger/ledger.git - cd ledger && ./acprep update # Update to the latest, configure, make + $ git clone git://github.com/ledger/ledger.git + $ cd ledger && ./acprep update # Update to the latest, configure, make Now try your first ledger command: - ./ledger -f test/input/sample.dat reg + $ ./ledger -f test/input/sample.dat reg For help on keeping your journal have a look at the -[documentation](http://www.ledger-cli.org/docs.html) and the -[wiki](http://wiki.ledger-cli.org/) (Also see the “Resources” section at the +[documentation] and the [wiki][] (Also see the “Resources” section at the end of this file). An emacs mode for ledger files can be found in the `lisp` -directory and a vim plugin is located in the [ledger/vim-ledger -repository](https://github.com/ledger/vim-ledger). +directory and a vim plugin is located in the [ledger/vim-ledger repository]. ## To the Rest If you're reading this file, you have in your hands the Bleeding Edge. This may very well *not* be what you want, since it's not guaranteed to be in a functionally complete state. It's under active development, and may change in -any way at any time. +any way at any time. What you may prefer is the **CURRENT** stable release, or +the **BETA** branch. -What you may prefer is the current stable release, or the current beta branch. -The **BETA** is what I prefer people use, since I still have a chance to fix -major bugs that you find. Just e-mail me, or post to the mailing list, -they'll become a part of my work list. - -<table> -<tr><td><strong>RELEASE</strong></td><td><tt>git checkout v3.1</tt></td></tr> -<tr><td><strong>CURRENT</strong></td><td><tt>git checkout maint</tt></td></tr> -<tr><td><strong>BETA</strong></td><td><tt>git checkout -b master origin/master</tt></td></tr> -<tr><td><strong>ALPHA</strong></td><td><tt>git checkout -b next origin/next</tt></td></tr> -</table> +Branch | Command +-------|-------- +**RELEASE** | `git checkout -b stable v3.1` | +**CURRENT** | `git checkout -b master origin/master` | +**BETA** | `git checkout -b 3.1.1 release/3.1.1` | +**ALPHA** | `git checkout -b next origin/next` | There are also several topic branches which contain experimental features, though none of these are guaranteed to compile. Best to chat with me on -[IRC](irc://irc.freenode.net/ledger) or via the -[mailing list](http://groups.google.com/group/ledger-cli) before going too -much further with those. +[IRC] or via the [mailing list] before going too much further with those. ## Dependencies @@ -66,53 +58,53 @@ If you wish to proceed in this venture, you'll need a few dependencies. The easiest way to get them for your platform is to run this handy Python script: - ./acprep dependencies + $ ./acprep dependencies If that doesn't completely work, here are the dependencies for building the current `master` branch: -<table> -<tr><td>Boost</td><td>1.35</td><td></td></tr> -<tr><td>GMP</td><td>4.2.2</td><td></td></tr> -<tr><td>MPFR</td><td>2.4.0</td><td></td></tr> -<tr><td>utfcpp</td><td>2.3.4</td><td></td></tr> -<tr><td>gettext</td><td>0.17</td><td><em>optional</em></td></tr> -<tr><td>libedit</td><td>20090111-3.0</td><td><em>optional</em></td></tr> -<tr><td>Python</td><td>2.4</td><td><em>optional</em></td></tr> -<tr><td>doxygen</td><td>1.5.7.1</td><td><em>optional</em>, for <tt>make docs</tt></td></tr> -<tr><td>graphviz</td><td>2.20.3</td><td><em>optional</em>, for <tt>make docs</tt></td></tr> -<tr><td>texinfo</td><td>4.13</td><td><em>optional</em>, for <tt>make docs</tt></td></tr> -<tr><td>lcov</td><td>1.6</td><td><em>optional</em>, for <tt>make report</tt>, used with <tt>/./acprep gcov</tt></td></tr> -<tr><td>sloccount</td><td>2.26</td><td><em>optional</em>, for <tt>make sloc</tt></td></tr> -</table> - -And for building the current `maint` branch: - -<table> -<tr><td>GMP</td><td>4.2.2</td><td> </td></tr> -<tr><td>pcre</td><td>7.7</td><td> </td></tr> -<tr><td>libofx</td><td>0.8.3</td><td><em>optional</em></td></tr> -<tr><td>expat</td><td>2.0.1</td><td><em>optional</em></td></tr> -<tr><td>libxml2</td><td>2.7.2</td><td><em>optional</em></td></tr> -</table> - -### OS X - -You can use [MacPorts](https://www.macports.org/) or [homebrew](http://brew.sh/) to install this very quickly on OS X. +Dependency | Version (or greater) +-----------|--------------------- +[Boost] | 1.49 +[GMP] | 4.2.2 +[MPFR] | 2.4.0 +[utfcpp] | 2.3.4 +[gettext] | 0.17 _optional_ +[libedit] | 20090111-3.0 _optional_ +[Python] | 2.4 _optional_ +[doxygen] | 1.5.7.1 _optional_, for `make docs` +[graphviz] | 2.20.3 _optional_, for `make docs` +[texinfo] | 4.13 _optional_, for `make docs` +[lcov] | 1.6 _optional_, for `make report`, used with `/./acprep gcov` +[sloccount] | 2.26 _optional_, for `make sloc` + +And for building the outdated `release/2.6.3` branch: + +Dependency | Version +-----------|-------- +[GMP] | 4.2.2 +[pcre] | 7.7 +[libofx] | 0.8.3 _optional_ +[expat] | 2.0.1 _optional_ +[libxml2] | 2.7.2 _optional_ + +### Mac OS X + +You can use [Homebrew] or [MacPorts] to install Ledger easily on OS X. #### 1. Homebrew You can see the parameters you can pass while installing with brew by the command `brew options ledger`. To install ledger, simply type the following command: - brew install ledger + $ brew install ledger If everything worked well, you should have ledger working now. If you want to install this with python bindings, you can use the following command: - brew install ledger --with-python + $ brew install ledger --with-python If you to want to startup python, use the following command: - ledger python + $ ledger python #### 2. MacPorts @@ -120,7 +112,7 @@ If you to want to startup python, use the following command: If you build stuff using MacPorts on OS X, as I do, here is what you would run: - sudo port install -f cmake python26 \ + $ sudo port install -f cmake python26 \ libiconv +universal zlib +universal gmp +universal \ mpfr +universal ncurses +universal ncursesw +universal \ gettext +universal libedit +universal boost-jam \ @@ -132,7 +124,7 @@ run: If you're going to build on Ubuntu, `sudo apt-get install ...` the following packages (current as of Ubuntu 14.04): - sudo apt-get install build-essential cmake doxygen \ + $ sudo apt-get install build-essential cmake doxygen \ libboost-system-dev libboost-dev python-dev gettext git \ libboost-date-time-dev libboost-filesystem-dev \ libboost-iostreams-dev libboost-python-dev libboost-regex-dev \ @@ -140,7 +132,7 @@ following packages (current as of Ubuntu 14.04): Or, for Ubuntu 12.04: - sudo apt-get install build-essential cmake zlib1g-dev libbz2-dev \ + $ sudo apt-get install build-essential cmake zlib1g-dev libbz2-dev \ python-dev gettext libgmp3-dev libmpfr-dev libboost-dev \ libboost-regex-dev libboost-date-time-dev \ libboost-filesystem-dev libboost-python-dev texinfo lcov \ @@ -155,7 +147,7 @@ Debian 7 (wheezy) and Debian 8 (jessie) contain all components needed to build ledger. You can install all required build dependencies using the following command: - sudo apt-get install build-essential cmake autopoint texinfo python-dev \ + $ sudo apt-get install build-essential cmake autopoint texinfo python-dev \ zlib1g-dev libbz2-dev libgmp3-dev gettext libmpfr-dev \ libboost-date-time-dev libboost-filesystem-dev \ libboost-graph-dev libboost-iostreams-dev \ @@ -167,12 +159,13 @@ The next step is preparing your environment for building. While you can use `cmake .` and make, I've prepared a script that does a lot more of the footwork for you: - ./acprep update + $ ./acprep update # or, if you want to use the Boost libraries with suffix -mt, install in # $HOME/local and build with 2 processes in parallel - ./acprep update --boost-suffix=-mt --prefix=$HOME/local -j2 + $ ./acprep update --boost-suffix=-mt --prefix=$HOME/local -j2 -Please read the contents of `config.log` if the configure step fails. Also, +Please read the contents of `CMakeFiles/CMakeOutput.log` and +`CMakeFiles/CMakeError.log` if the configure step fails. Also, see the `help` subcommand to `acprep`, which explains some of its many options. It's pretty much the only command I run for configuring, building and testing Ledger. @@ -183,14 +176,41 @@ You can run `make check` to confirm the result, and `make install` to install. Now that you're up and running, here are a few resources to keep in mind: - - [Home page](http://ledger-cli.org) - - [Documentation](http://www.ledger-cli.org/docs.html) - - [IRC channel](irc://irc.freenode.net/ledger) - - [Mailing List / Forum](http://groups.google.com/group/ledger-cli) - - [GitHub project page](http://github.com/ledger/ledger) - - [Ohloh code analysis](http://www.ohloh.net/projects/ledger) + - [Homepage] + - [Documentation] + - [IRC channel][IRC] + - [Mailing List / Forum][mailing list] + - [GitHub project page][github] + - [Code analysis][openhub] If you have ideas you'd like to share, the best way is either to e-mail me a patch (I prefer attachments over pasted text), or to get an account on GitHub. -Once you do, fork the [Ledger project](http://github.com/ledger/ledger), +Once you do, fork the [Ledger project][github], hack as much as you like, then send me a pull request via GitHub. + +[Homepage]: http://ledger-cli.org/ +[documentation]: http://www.ledger-cli.org/docs.html +[mailing list]: http://list.ledger-cli.org/ +[wiki]: http://wiki.ledger-cli.org/ +[IRC]: irc://irc.freenode.net/ledger +[github]: http://github.com/ledger/ledger +[ledger/vim-ledger repository]: https://github.com/ledger/vim-ledger +[Homebrew]: http://brew.sh/ +[MacPorts]: https://www.macports.org/ +[Boost]: http://boost.org +[GMP]: http://gmplib.org/ +[MPFR]: http://www.mpfr.org/ +[utfcpp]: http://utfcpp.sourceforge.net +[gettext]: https://www.gnu.org/software/gettext/ +[libedit]: http://thrysoee.dk/editline/ +[Python]: http://python.org +[doxygen]: http://www.doxygen.org/ +[graphviz]: http://graphviz.org/ +[texinfo]: http://www.gnu.org/software/texinfo/ +[lcov]: http://ltp.sourceforge.net/coverage/lcov.php +[sloccount]: http://www.dwheeler.com/sloccount/ +[pcre]: http://www.pcre.org/ +[libofx]: http://libofx.sourceforge.net +[expat]: http://www.libexpat.org +[libxml2]: http://xmlsoft.org +[openhub]: https://www.openhub.net/p/ledger |