summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJohn Wiegley <johnw@newartisans.com>2008-09-11 04:46:13 -0400
committerJohn Wiegley <johnw@newartisans.com>2008-09-11 04:46:13 -0400
commit3add2229e0dd1f583596a313a76991249a521bae (patch)
tree696ec818bbd6eefe70d49a5bd5a2b290e10e3690 /README
parent1ba7abdf9b23d33a70a1f95eb352d13f38772deb (diff)
downloadfork-ledger-3add2229e0dd1f583596a313a76991249a521bae.tar.gz
fork-ledger-3add2229e0dd1f583596a313a76991249a521bae.tar.bz2
fork-ledger-3add2229e0dd1f583596a313a76991249a521bae.zip
Updated README notes.
Diffstat (limited to 'README')
-rw-r--r--README83
1 files changed, 40 insertions, 43 deletions
diff --git a/README b/README
index bc3ac18f..f2c1f756 100644
--- a/README
+++ b/README
@@ -1,40 +1,40 @@
Hello, and welcome to the Ledger source code!
-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.
+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.
-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:
+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.1b origin/v2.6.1b
-The BETA is what I prefer people use, since I still have a change to fix
-major bugs that you find. Just log them in the track against 2.6.1 and
-they'll become a part of my work list.
+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.
RELEASE: git checkout v2.6.0.90
-This is the same release code that you can download via tarball from the
-home page. It has some serious issues dealing with date/time handling,
-although at least its major flaws are mostly known by now.
+This is the same release code that you can download via tarball from the home
+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 at any time by using
-this command:
+You can jump over to the current active development at any time by using this
+command:
DEVEL: git checkout master
-There are also several topic branches which contain experimental
-features, although none of these are guaranteed even to compile. Best
-to chat with me on IRC or via the mailing list before going too much
-further with those.
+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
+IRC or via the mailing list before going too much further with those.
------------------------------------------------------------------------
-Now, if you wish to proceed in this venture, you'll need a few
-dependencies:
+Now, if you wish to proceed in this venture, you'll need a few dependencies:
+
+ - GMP 4.2.2 -- for all builds
- 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:
sudo port install boost +complete+python25
- sudo port install cppunit expat libofx
+ sudo port install gmp pcre cppunit expat libofx
* Ubuntu
@@ -63,8 +63,8 @@ If you're going to be building with Ubuntu, the command is:
* Using my Git mirrors
Finally, for the convenience of fellow developers on the master (DEVEL)
-branch, you may download and build some of these dependencies quite
-easily. Just run this command:
+branch, you may download and build some of these dependencies quite easily.
+Just run this command:
git submodule init
git submodule update
@@ -76,9 +76,9 @@ most importantly Boost and CppUnit.
------------------------------------------------------------------------
-The next step is preparing your environment for building. While you can
-just use 'autoreconf -fi', I've prepared a script that does a lot of the
-footwork for you:
+The next step is preparing your environment for building. While you can just
+use 'autoreconf -fi', I've prepared a script that does a lot of the footwork
+for you:
./acprep
@@ -86,39 +86,36 @@ If you want to run with complete debugging on, as I do, use this:
./acprep --devel
-Please read the contents of 'acprep' in this case, especially the
-section which documents the --devel option.
+Please read the contents of 'acprep' in this case, especially the section
+which documents the --devel option.
------------------------------------------------------------------------
-Once you have the dependencies installed and the source prepared for
-building, just run 'make'. If you have CppUnit installed, I prefer that
-you always run 'make fullcheck', as this will verify Ledger against the
-unit tests, the Python unit tests (if applicable), and the regression
-tests, for your platform.
+Once you have the dependencies installed and the source prepared for building,
+just run 'make'. If you have CppUnit installed, I prefer that you always run
+'make fullcheck', as this will verify Ledger against the unit tests, the
+Python unit tests (if applicable), and the regression tests, for your
+platform.
If you have extra CPU cycles to burn, try even 'make distcheck', which
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
-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
-
IRC channel #ledger on irc.freenode.net
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
Buildbot display http://www.newartisans.com:9090
Ohloh code analysis http://www.ohloh.net/projects/ledger
-If you have coding ideas you want to share, the best way is either to
-e-mail me a patch (I prefer ttachments 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 message via GitHub asking me to check out
-your repository. I'm only too happy to do so for anyone who takes time
-out of their schedule to help the Ledger project.
+If you have coding ideas you want to share, the best way is either to e-mail
+me a patch (I prefer ttachments 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 message via GitHub asking me to check out your repository. I'm only
+too happy to do so for anyone who takes time out of their schedule to help the
+Ledger project.
John