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

Updated README notes.

Browse source
This commit is contained in:
John Wiegley 2008-09-11 04:46:13 -04:00
parent 1ba7abdf9b
commit 3add2229e0
1 changed files with 40 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

83
README
View file

@ -1,40 +1,40 @@
Hello, and welcome to the Ledger source code! Hello, and welcome to the Ledger source code!
If you're reading this file, you have in your hands the Bleeding Edge. If you're reading this file, you have in your hands the Bleeding Edge. This
This may very well *NOT* be what you want, since it's not guaranteed to may very well *NOT* be what you want, since it's not guaranteed to be in a
be in a functionally complete state. It's under active development, and functionally complete state. It's under active development, and may change in
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 What you may prefer is the current stable release, or the current beta branch.
branch. At this moment, you can get there by one of two commands: At this moment, you can get there by one of two commands:
BETA: git checkout -b v2.6.1b origin/v2.6.1b BETA: git checkout -b v2.6.1b origin/v2.6.1b
The BETA is what I prefer people use, since I still have a change to fix The BETA is what I prefer people use, since I still have a chance to fix major
major bugs that you find. Just log them in the track against 2.6.1 and bugs that you find. Just e-mail me, or post to the mailing list, they'll
they'll become a part of my work list. become a part of my work list.
RELEASE: git checkout v2.6.0.90 RELEASE: git checkout v2.6.0.90
This is the same release code that you can download via tarball from the This is the same release code that you can download via tarball from the home
home page. It has some serious issues dealing with date/time handling, page. It has some serious issues dealing with date/time handling, but at
although at least its major flaws are mostly known by now. least its major flaws are mostly known by now.
You can jump over to the current active development at any time by using You can jump over to the current active development at any time by using this
this command: command:
DEVEL: git checkout master DEVEL: git checkout master
There are also several topic branches which contain experimental There are also several topic branches which contain experimental features,
features, although none of these are guaranteed even to compile. Best though none of these are guaranteed even to compile. Best to chat with me on
to chat with me on IRC or via the mailing list before going too much IRC or via the mailing list before going too much further with those.
further with those.
------------------------------------------------------------------------ ------------------------------------------------------------------------
Now, if you wish to proceed in this venture, you'll need a few Now, if you wish to proceed in this venture, you'll need a few dependencies:
dependencies:
- GMP 4.2.2 -- for all builds
- PCRE 7.7 -- if you're building BETA or RELEASE - PCRE 7.7 -- if you're building BETA or RELEASE
@ -50,7 +50,7 @@ dependencies:
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 +complete+python25 sudo port install boost +complete+python25
sudo port install cppunit expat libofx sudo port install gmp pcre cppunit expat libofx
* Ubuntu * Ubuntu
@ -63,8 +63,8 @@ If you're going to be building with Ubuntu, the command is:
* Using my Git mirrors * Using my Git mirrors
Finally, for the convenience of fellow developers on the master (DEVEL) Finally, for the convenience of fellow developers on the master (DEVEL)
branch, you may download and build some of these dependencies quite branch, you may download and build some of these dependencies quite easily.
easily. Just run this command: Just run this command:
git submodule init git submodule init
git submodule update git submodule update
@ -76,9 +76,9 @@ most importantly Boost and CppUnit.
------------------------------------------------------------------------ ------------------------------------------------------------------------
The next step is preparing your environment for building. While you can The next step is preparing your environment for building. While you can just
just use 'autoreconf -fi', I've prepared a script that does a lot of the use 'autoreconf -fi', I've prepared a script that does a lot of the footwork
footwork for you: for you:
./acprep ./acprep
@ -86,39 +86,36 @@ If you want to run with complete debugging on, as I do, use this:
./acprep --devel ./acprep --devel
Please read the contents of 'acprep' in this case, especially the Please read the contents of 'acprep' in this case, especially the section
section which documents the --devel option. which documents the --devel option.
------------------------------------------------------------------------ ------------------------------------------------------------------------
Once you have the dependencies installed and the source prepared for Once you have the dependencies installed and the source prepared for building,
building, just run 'make'. If you have CppUnit installed, I prefer that just run 'make'. If you have CppUnit installed, I prefer that you always run
you always run 'make fullcheck', as this will verify Ledger against the 'make fullcheck', as this will verify Ledger against the unit tests, the
unit tests, the Python unit tests (if applicable), and the regression Python unit tests (if applicable), and the regression tests, for your
tests, for your platform. platform.
If you have extra CPU cycles to burn, try even 'make distcheck', which If you have extra CPU cycles to burn, try even 'make distcheck', which
provides the most thorough shakedown of a healthy source tree. provides the most thorough shakedown of a healthy source tree.
------------------------------------------------------------------------ ------------------------------------------------------------------------
Now that you're up and running, here are a few resources to keep in Now that you're up and running, here are a few resources to keep in mind:
mind:
Home page http://www.newartisans.com/software/ledger.html Home page http://www.newartisans.com/software/ledger.html
IRC channel #ledger on irc.freenode.net IRC channel #ledger on irc.freenode.net
Mailing List / Forum http://groups.google.com/group/ledger-cli Mailing List / Forum http://groups.google.com/group/ledger-cli
Issue Tracker http://trac.newartisans.com/ledger
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 coding ideas you want to share, the best way is either to If you have coding ideas you want to share, the best way is either to e-mail
e-mail me a patch (I prefer ttachments over pasted text), or to get an me a patch (I prefer ttachments over pasted text), or to get an account on
account on GitHub. Once you do, fork the Ledger project, hack as much GitHub. Once you do, fork the Ledger project, hack as much as you like, then
as you like, then send me a message via GitHub asking me to check out send me a message via GitHub asking me to check out your repository. I'm only
your repository. I'm only too happy to do so for anyone who takes time too happy to do so for anyone who takes time out of their schedule to help the
out of their schedule to help the Ledger project. Ledger project.
John John