summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorNoah Slater <nslater@apache.org>2008-03-30 17:04:06 +0000
committerNoah Slater <nslater@apache.org>2008-03-30 17:04:06 +0000
commit4ebc9a023d7a739a5a129149ce0e59c0a462d735 (patch)
treeb992330c03f5e0251bc550e23187a397c4c5ca99 /README
parent8759808415c705fecb4ae35cdb9b554d016ab6c6 (diff)
corrected Markdown formatting and updated from google to apache
git-svn-id: https://svn.apache.org/repos/asf/incubator/couchdb/trunk@642775 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'README')
-rw-r--r--README57
1 files changed, 34 insertions, 23 deletions
diff --git a/README b/README
index 0e9cb228..5205ef67 100644
--- a/README
+++ b/README
@@ -4,29 +4,24 @@
You can skip this section if you are installing from a release tarball.
-### Checking Out ###
-
-See the [http://incubator.apache.org/couchdb/community/code.html](instructions)
-on how to check out the source code.
-
### Dependencies ###
To build Apache CouchDB from checkout you need some of the following installed:
- * [GNU Automake](http://www.gnu.org/software/automake/) (>=1.6.3) (required)
- * [GNU Autoconf](http://www.gnu.org/software/autoconf/) (>=2.59) (required)
- * [GNU Libtool](http://www.gnu.org/software/libtool/) (required)
- * [svn2cl](http://ch.tudelft.nl/~arthur/svn2cl/) (optional)
- * [xsltproc](http://xmlsoft.org/XSLT/xsltproc2.html) (optional)
- * [help2man](http://www.gnu.org/software/help2man/) (optional)
+ * [GNU Automake][01] (>=1.6.3) (required)
+ * [GNU Autoconf][02] (>=2.59) (required)
+ * [GNU Libtool][03] (required)
+ * [svn2cl][04] (optional)
+ * [xsltproc][05] (optional)
+ * [help2man][06] (optional)
If you are running a Debian GNU/Linux system (or a derivative such as Ubuntu
GNU/Linux) you can install these dependencies using the `apt-get` command:
apt-get install automake autoconf libtool subversion-tools help2man
-If you are running OS X and have [MacPorts](http://www.macports.org/) installed
-you can install some of these dependencies by using the `port` command:
+If you are running OS X and have [MacPorts][07] installed you can install some of
+these dependencies by using the `port` command:
port install automake autoconf libtool help2man
@@ -38,7 +33,8 @@ Note: MacPorts users will need to install svn2cl by hand.
Note: You must repeat this step every time you update your Subversion checkout.
-Bootstrap the pristine source by running the following command:
+Follow the [check out instructions][08] and bootstrap the pristine source by
+running the following command:
./bootstrap
@@ -48,11 +44,11 @@ You can use the `-C` option to generate a dummy `ChangeLog` file.
You will need the following installed:
- * [Erlang OTP](http://erlang.org/) (required)
- * [ICU](http://icu.sourceforge.net/) (required)
- * [Mozilla SpiderMonkey](http://www.mozilla.org/js/spidermonkey/) (required)
- * [GNU Make](http://www.gnu.org/software/make/) (required)
- * [GNU Compiler Collection](http://gcc.gnu.org/) (required)
+ * [Erlang OTP][09] (required)
+ * [ICU][10] (required)
+ * [Mozilla SpiderMonkey][11] (required)
+ * [GNU Make][12] (required)
+ * [GNU Compiler Collection][13] (required)
### UNIX-like Operating Systems (inc. OS X) ###
@@ -77,7 +73,7 @@ the Xcode Tools metapackage by running the following command:
open /Applications/Installers/Xcode\ Tools/XcodeTools.mpkg
We recommend that you satisfy the other dependancies by installing
-[MacPorts](http://www.macports.org/) and running the following command:
+[MacPorts][07] and running the following command:
port install icu erlang spidermonkey
@@ -136,8 +132,7 @@ On many UNIX-like systems you can run the following command:
OS X provides the standard Accounts option from the System Preferences
application or you can optionally use the Workgroup Manager application which
-can be downloaded as part of the [Server Admin Tools](
-http://www.apple.com/support/downloads/serveradmintools1047.html).
+can be downloaded as part of the [Server Admin Tools][14].
You should set the home directory of the `couchdb` user to
`/usr/local/var/lib/couchdb` which is the Apache CouchDB database directory.
@@ -163,7 +158,7 @@ When Apache CouchDB starts it should eventually display the following message:
Relax.
To check that everything has worked point your web browser to
-http://localhost:5984/_utils/index.html and run the test suite.
+[http://localhost:5984/_utils/index.html][15] and run the test suite.
##### OS X #####
@@ -237,3 +232,19 @@ your system wide `/Library/LaunchDaemons` directory.
### Windows ###
Windows documentation is incomplete. Please submit suggestions.
+
+[01]: http://www.gnu.org/software/automake/
+[02]: http://www.gnu.org/software/autoconf/
+[03]: http://www.gnu.org/software/libtool/
+[04]: http://ch.tudelft.nl/~arthur/svn2cl/
+[05]: http://xmlsoft.org/XSLT/xsltproc2.html
+[06]: http://www.gnu.org/software/help2man/
+[07]: http://www.macports.org/
+[08]: http://incubator.apache.org/couchdb/community/code.html
+[09]: http://erlang.org/
+[10]: http://icu.sourceforge.net/
+[11]: http://www.mozilla.org/js/spidermonkey/
+[12]: http://www.gnu.org/software/make/
+[13]: http://gcc.gnu.org/
+[14]: http://www.apple.com/support/downloads/serveradmintools1047.html
+[15]: http://localhost:5984/_utils/index.html