diff options
author | Noah Slater <nslater@apache.org> | 2008-03-30 17:04:06 +0000 |
---|---|---|
committer | Noah Slater <nslater@apache.org> | 2008-03-30 17:04:06 +0000 |
commit | 4ebc9a023d7a739a5a129149ce0e59c0a462d735 (patch) | |
tree | b992330c03f5e0251bc550e23187a397c4c5ca99 | |
parent | 8759808415c705fecb4ae35cdb9b554d016ab6c6 (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
-rw-r--r-- | BUGS | 4 | ||||
-rw-r--r-- | NOTICE | 4 | ||||
-rw-r--r-- | README | 57 | ||||
-rw-r--r-- | TROUBLESHOOTING | 10 | ||||
-rw-r--r-- | acinclude.m4.in | 7 | ||||
-rwxr-xr-x | bootstrap | 2 |
6 files changed, 49 insertions, 35 deletions
@@ -1,5 +1,5 @@ # Bugs # -Report bugs via [the web](http://groups.google.com/group/couchdb). +Please see the [documentation][1] on how to report bugs with Apache CouchDB. -Report bugs via [email](couchdb@googlegroups.com). +[1] http://incubator.apache.org/couchdb/community/issues.html @@ -1,6 +1,6 @@ # Notice # -Developed at [The Apache Software Foundation](http://www.apache.org/). +Developed at [The Apache Software Foundation][1]. Core software: @@ -15,3 +15,5 @@ Supporting software: * share/www/script/jquery.js (Copyright (C) 2008 John Resig.) * share/www/script/json2.js (This file is in the public domain.) * src/couch_inets (Copyright (C) 1999 Ericsson Utvecklings AB.) + +[1]: http://www.apache.org/ @@ -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 diff --git a/TROUBLESHOOTING b/TROUBLESHOOTING index b2963ab6..78ef7e23 100644 --- a/TROUBLESHOOTING +++ b/TROUBLESHOOTING @@ -4,7 +4,7 @@ Have you built CouchDB from the Subversion repository? -Did you do a svn up that seemed to break everything? +Did you do a `svn up` that seemed to break everything? After every update you must run the following command: @@ -24,11 +24,9 @@ output of each step. 2. Note down the installed versions of CouchDB's dependancies. - 3. Checkout a fresh version from Subversion: + 3. Follow the [checkout instructions][1] to get a fresh copy of trunk. - svn checkout http://couchdb.googlecode.com/svn/trunk/ couchdb - - 4. Bootstrap from the couchdb directory: + 4. Bootstrap from the `couchdb` directory: ./bootstrap -C @@ -50,3 +48,5 @@ output of each step. 2. Please add documentation for your system... 8. Report back to the mailing list (or IRC) with the output from each step. + +[1]: http://incubator.apache.org/couchdb/community/code.html diff --git a/acinclude.m4.in b/acinclude.m4.in index c537bf90..6fe7768d 100644 --- a/acinclude.m4.in +++ b/acinclude.m4.in @@ -11,7 +11,7 @@ dnl License for the specific language governing permissions and limitations dnl under the License. m4_define([LOCAL_PACKAGE_AUTHOR_NAME], [Damien Katz]) -m4_define([LOCAL_PACKAGE_AUTHOR_ADDRESS], [damien_katz@yahoo.com]) +m4_define([LOCAL_PACKAGE_AUTHOR_ADDRESS], [damien@apache.org]) m4_define([LOCAL_PACKAGE_IDENTIFIER], [couchdb]) m4_define([LOCAL_PACKAGE_NAME], [Apache CouchDB]) @@ -27,5 +27,6 @@ m4_define([LOCAL_VERSION_SECONDARY], m4_define([LOCAL_VERSION], [LOCAL_VERSION_PRIMARY[]LOCAL_VERSION_SECONDARY]) -m4_define([LOCAL_LIST_ADDRESS], [couchdb@googlegroups.com]) -m4_define([LOCAL_LIST_URI], [http://groups.google.com/group/couchdb]) +m4_define([LOCAL_LIST_ADDRESS], [couchdb-user@incubator.apache.org]) +m4_define([LOCAL_LIST_URI], + [http://mail-archives.apache.org/mod_mbox/incubator-couchdb-user/]) @@ -33,7 +33,7 @@ COPYING_FILE="COPYING" LICENSE_COMPRESSED_FILE="build-contrib/apache_2.txt.gz" M4_DIRECTORY="m4" M4_AC_CHECK_ICU_FILE="m4/ac_check_icu.m4" -REPOSITORY_URI="http://couchdb.googlecode.com/svn/trunk/" +REPOSITORY_URI="http://svn.apache.org/repos/asf/incubator/couchdb/trunk" ACLOCAL_EXECUTABLE=$(which aclocal || true) AUTOCONF_EXECUTABLE=$(which autoconf || true) |