sfos/ledger
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Converted README to Textile, to better suite Github.

Browse source
This commit is contained in:
John Wiegley 2009-02-02 16:36:07 -04:00
parent f857b33dad
commit 101dea67bb
1 changed files with 76 additions and 63 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

139
README
View file

@ -1,5 +1,21 @@
Hello, and welcome to the Ledger source code!
Hello, and welcome to the Ledger source code! h1. For the Impatient
I know, you just want to build and play. Do this:
<pre>
./acprep && make check
</pre>
If you have all the dependencies installed (see below), this is all you need.
Now try your first ledger command:
<pre>
./ledger -f doc/sample.dat reg
</pre>
h1. To the Rest
If you're reading this file, you have in your hands the Bleeding Edge. This 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 may very well *NOT* be what you want, since it's not guaranteed to be in a
@ -7,108 +23,105 @@ 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 current beta branch. What you may prefer is the current stable release, or the current beta branch.
At this moment, you can get there by one of two commands:
BETA: git checkout -b v2.6.2b origin/v2.6.2b
The BETA is what I prefer people use, since I still have a chance to fix major 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 bugs that you find. Just e-mail me, or post to the mailing list, they'll
become a part of my work list. become a part of my work list.
RELEASE: git checkout v2.6.1 | CURRENT | git checkout master |
| BETA | git checkout -b v2.6.2b origin/v2.6.2b |
This is the same release code that you can download via tarball from the home | RELEASE | git checkout v2.6.1 |
page. It has some serious issues dealing with date/time handling, but at
least its major flaws are mostly known by now.
You can jump over to the current active development (aka 3.0) at any time by
using this command:
DEVEL: git checkout master
There are also several topic branches which contain experimental features, There are also several topic branches which contain experimental features,
though none of these are guaranteed even to compile. Best to chat with me on though none of these are guaranteed to compile. Best to chat with me on IRC
IRC or via the mailing list before going too much further with those. (#ledger, irc.freenode.net) or via the mailing list
(http://groups.google.com/group/ledger-cli) before going too much further with
those.
------------------------------------------------------------------------ h1. Dependencies
If you wish to proceed in this venture, you'll need a few dependencies: If you wish to proceed in this venture, you'll need a few dependencies:
- Boost 1.35 or higher -- if you're building DEVEL | Boost | 1.35 or higher | if you're building CURRENT |
- Python 2.4 or higher -- optional | Python | 2.4 or higher | optional |
- GMP 4.2.2 -- for all builds | GMP | 4.2.2 | for all builds |
- MPFR 2.4.0 -- for all builds | MPFR | 2.4.0 | if you're building CURRENT |
- libofx 0.8.3 -- optional | libofx | 0.8.3 | optional |
| pcre | 7.7 | if you're building BETA or RELEASE |
| cppunit | 1.12.1 | if you're building CURRENT |
| lcov | 1.6 | optional, for "make report" |
| doxygen | 1.5.7.1 | optional, for "make docs" |
| texinfo | 4.13 | optional, for "make docs" |
- pcre 7.7 -- if you're building BETA or RELEASE h2. MacPorts
- cppunit 1.12.1 -- if you're building DEVEL
- lcov 1.6 -- optional, for "make report"
- doxygen 1.5.7.1 -- optional, for "make docs"
- texinfo 4.13 -- optional, for "make docs"
* MacPorts
If you build stuff using MacPorts, as I do, here is what you would run: If you build stuff using MacPorts, as I do, here is what you would run:
sudo port install boost +python25+st <pre>
sudo port install gmp mpfr pcre libofx sudo port install boost +python25+st
sudo port install cppunit doxygen texlive texinfo lcov sudo port install gmp mpfr pcre libofx
sudo port install cppunit doxygen texlive texinfo lcov
</pre>
You can even just install the current Ledger release directly: You can even just install the current Ledger release directly:
sudo port install ledger <pre>
sudo port install ledger
</pre>
* Ubuntu h2. Ubuntu
If you're going to be build on Ubuntu, "sudo apt-get install ..." the If you're going to be build on Ubuntu, @sudo apt-get install ...@
following packages (current as of Ubuntu Hardy): the following packages (current as of Ubuntu Hardy):
build-essential libtool autoconf automake texinfo python-dev <pre>
zlib1g-dev libbz2-dev stow libgmp3-dev bjam libboost-dev build-essential libtool autoconf automake texinfo python-dev
libboost-regex-dev libboost-date-time-dev libboost-filesystem-dev zlib1g-dev libbz2-dev stow libgmp3-dev bjam libboost-dev
libboost-regex-dev libboost-date-time-dev libboost-filesystem-dev
</pre>
------------------------------------------------------------------------ h1. Preparing the Build
The next step is preparing your environment for building. While you can use The next step is preparing your environment for building. While you can use
'autogen.sh', I've prepared a script that does a lot more of the footwork for @autogen.sh@, I've prepared a script that does a lot more of the
you: footwork for you:
./acprep <pre>
./acprep
</pre>
If you want to run with complete debugging on, as I do, use this: If you want to run with complete debugging on, as I do, use this:
./acprep --devel --boost SUFFIX <pre>
./acprep --devel --boost SUFFIX
</pre>
Where SUFFIX is the letters that occur after "libboost_regex-SUFFIX.a" in your Where *SUFFIX* is the letters that occur after @libboost_regex-SUFFIX.a@ in
library directory. It might be "mt", or "xgcc40", or "st", etc. your library directory. It might be @mt@, or @xgcc40@, or @st@, etc.
Please read the contents of 'config.log' if the configure step fails. Please read the contents of @config.log@ if the configure step fails.
------------------------------------------------------------------------ h1. Building
Once you have the dependencies installed and the source prepared for building, Once you have the dependencies installed and the source prepared for building,
run 'make'. If you have CppUnit installed, I prefer you always run 'make run @make@. If you have CppUnit installed, I prefer you always run
fullcheck', as this will verify Ledger against the unit tests, the Python unit @make fullcheck@, as this will verify Ledger against the unit tests, the
tests (if applicable), and the regression tests. Python unit tests (if applicable), and the regression tests.
If you have extra CPU cycles to burn, perhaps try 'make release-distcheck', If you have extra CPU cycles to burn, perhaps try @make release-distcheck@,
which provides the most thorough shakedown of a healthy source tree. which provides the most thorough shakedown of a healthy source tree.
------------------------------------------------------------------------ h1. Resources
Now that you're up and running, here are a few resources to keep in mind: Now that you're up and running, here are a few resources to keep in mind:
Home page http://www.newartisans.com/software/ledger.html | Home page | http://www.newartisans.com/software/ledger.html |
IRC channel #ledger, irc.freenode.net | IRC channel | #ledger, irc.freenode.net |
Mailing List / Forum http://groups.google.com/group/ledger-cli | Mailing List / Forum | http://groups.google.com/group/ledger-cli |
GitHub project page http://github.com/jwiegley/ledger/tree/master | GitHub project page | http://github.com/jwiegley/ledger/tree/master |
Buildbot display http://www.newartisans.com:9090 | Buildbot display | http://www.newartisans.com:9090 |
Ohloh code analysis http://www.ohloh.net/projects/ledger | Ohloh code analysis | http://www.ohloh.net/projects/ledger |
If you have ideas you'd like to share, the best way is either to e-mail me a 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. patch (I prefer attachments over pasted text), or to get an account on GitHub.
Once you do, fork the Ledger project, hack as much as you like, then send me a Once you do, fork the Ledger project, hack as much as you like, then send me a
pull request via GitHub. pull request via GitHub.
John