summaryrefslogtreecommitdiff
path: root/README.textile
diff options
context:
space:
mode:
Diffstat (limited to 'README.textile')
-rw-r--r--README.textile65
1 files changed, 43 insertions, 22 deletions
diff --git a/README.textile b/README.textile
index 50e15244..2a730746 100644
--- a/README.textile
+++ b/README.textile
@@ -45,17 +45,24 @@ much further with those.
h2. 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. The
+easiest way to get them for your platform is to run:
+
+<pre>
+./acprep dependencies
+</pre>
+
+If that doesn't completely work, read on.
h3. For building the current master branch
|_.Library|_.Min.Ver.|_.When needed|
-|Boost|1.35 or higher||
+|Boost|1.35||
|GMP|4.2.2||
|MPFR|2.4.0||
|gettext|0.17|_optional_|
|libedit|20090111-3.0|_optional_|
-|Python|2.4 or higher|_optional_|
+|Python|2.4|_optional_|
|cppunit|1.12.1|_optional_, for @make check@|
|doxygen|1.5.7.1|_optional_, for @make docs@|
|graphviz|2.20.3|_optional_, for @make docs@|
@@ -63,7 +70,7 @@ h3. For building the current master branch
|lcov|1.6|_optional_, for @make report@, used with @./acprep gcov@|
|sloccount|2.26|_optional_, for @make sloc@|
-h3. For building the beta or release branches
+h3. For building the current @maint@ branch
|_.Library|_.Min.Ver.|_.When needed|
|GMP|4.2.2||
@@ -74,12 +81,16 @@ h3. For building the beta or release branches
h3. MacPorts
-If you build stuff using MacPorts, as I do, here is what you would run:
+If you build stuff using MacPorts on OS X, as I do, here is what you would
+run:
<pre>
-sudo port install boost +python25+st gmp mpfr gettext libedit \
- cppunit texlive doxygen graphviz texinfo lcov \
- sloccount pcre libofx expat
+sudo port install -f automake autoconf libtool python26
+ libiconv +universal zlib +universal gmp +universal
+ mpfr +universal ncurses +universal ncursesw +universal
+ gettext +universal libedit +universal boost-jam
+ boost +st+python26+icu cppunit texlive doxygen graphviz
+ texinfo lcov sloccount
</pre>
You can even just install the current Ledger *RELEASE* directly:
@@ -90,25 +101,38 @@ sudo port install ledger
h3. Ubuntu
-If you're going to be build on Ubuntu, @sudo apt-get install ...@
-the following packages (current as of Ubuntu Hardy):
+If you're going to be build on Ubuntu, @sudo apt-get install ...@ the
+following packages (current as of Ubuntu Hardy):
+
+<pre>
+sudo apt-get install build-essential libtool autoconf automake \
+ zlib1g-dev libbz2-dev python-dev bjam cvs gettext libgmp3-dev \
+ libmpfr-dev libboost1.35-dev libboost-regex1.35-dev \
+ libboost-date-time1.35-dev libboost-filesystem1.35-dev \
+ libboost-python1.35-dev texinfo lcov sloccount
+</pre>
+
+Or, for Ubuntu Karmic:
<pre>
sudo apt-get install build-essential libtool autoconf automake \
- texinfo python-dev zlib1g-dev libbz2-dev stow libgmp3-dev \
- bjam libboost1.35-dev libboost-regex1.35-dev \
- libboost-date-time1.35-dev libboost-filesystem1.35-dev
+ texinfo python-dev zlib1g-dev libbz2-dev libgmp3-dev \
+ bjam gettext cvs libboost1.40-dev libboost-regex1.40-dev \
+ libboost-date-time1.40-dev libboost-filesystem1.40-dev \
+ libmpfr-dev
</pre>
-h2. Preparing the Build
+h2. Building
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
-you:
+@autogen.sh@, ./configure and make, I've prepared a script that does a lot more
+of the footwork for you:
<pre>
-./acprep pull # Make sure everything is pulled that needs to be
-./acprep
+./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=-mt -- --prefix=$HOME/local -j2
</pre>
Please read the contents of @config.log@ if the configure step fails. Also,
@@ -116,10 +140,7 @@ see the @help@ command to @acprep@, which explains some of its many options.
It's pretty much the only command I run for configuring, building and testing
Ledger.
-h2. Building
-
-Once you have the dependencies installed and the source prepared for building,
-run @make check@ to get things started and confirm the result.
+You can run @make check@ to confirm the result, and @make install@ to install.
If you have extra CPU cycles to burn, try @./acprep proof@, which provides the
most thorough shakedown of a healthy source tree.