summaryrefslogtreecommitdiff
path: root/BUILDING
diff options
context:
space:
mode:
authorNoah Slater <nslater@apache.org>2010-03-13 12:58:58 +0000
committerNoah Slater <nslater@apache.org>2010-03-13 12:58:58 +0000
commitdf02faf94ccac1b3ca0b213611c2f3fba7d9420d (patch)
tree472714a64434a02924ec32ceb0d80808e22e30c5 /BUILDING
parente42397b55ef426a5038d5053fdd5de9d6d484675 (diff)
initial round of documentation changes
git-svn-id: https://svn.apache.org/repos/asf/couchdb/trunk@922548 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'BUILDING')
-rw-r--r--BUILDING42
1 files changed, 42 insertions, 0 deletions
diff --git a/BUILDING b/BUILDING
new file mode 100644
index 00000000..206d6ced
--- /dev/null
+++ b/BUILDING
@@ -0,0 +1,42 @@
+Building From Checkout
+======================
+
+You only need to follow these instructions if you are building from a direct
+repository checkout. If you are installing CouchDB from a tarball you can skip
+to the installation section in the `README` file.
+
+You will need the following installed:
+
+ * GNU Automake (>=1.6.3) (http://www.gnu.org/software/automake/)
+ * GNU Autoconf (>=2.59) (http://www.gnu.org/software/autoconf/)
+ * GNU Libtool (http://www.gnu.org/software/libtool/)
+ * GNU help2man (http://www.gnu.org/software/help2man/)
+
+The `help2man` tool is optional, but will generate `man` pages for you.
+
+Debian-based (inc. Ubuntu) Systems
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can install the dependencies by running:
+
+ apt-get install automake autoconf libtool help2man
+
+Be sure to update the version numbers to match your system's available packages.
+
+Mac OS X
+~~~~~~~~
+
+You can install the dependencies by running:
+
+ port install automake autoconf libtool help2man
+
+You will need MacPorts installed to use the `port` command.
+
+Bootstrapping
+~~~~~~~~~~~~~
+
+Bootstrap the pristine source by running:
+
+ ./bootstrap
+
+You must repeat this step every time you update your checkout.