Permalink
Browse files

documentation improvements

git-svn-id: https://svn.apache.org/repos/asf/couchdb/trunk@922586 13f79535-47bb-0310-9956-ffa450edef68
  • Loading branch information...
1 parent 3eb752a commit f3303f24d376860a63ec735a1bc96c406473ad4f @nslater nslater committed Mar 13, 2010
Showing with 273 additions and 411 deletions.
  1. +0 −42 BUILDING
  2. +95 −0 DEVELOPERS
  3. +32 −11 INSTALL.Unix
  4. +94 −84 INSTALL.Windows
  5. +4 −4 Makefile.am
  6. +14 −245 README
  7. +34 −25 license.skip
View
@@ -1,42 +0,0 @@
-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.
View
@@ -0,0 +1,95 @@
+Apache CouchDB DEVELOPERS
+=========================
+
+Only follow these instructions if you are building from a source checkout.
+
+If you're unsure what this means, ignore this document.
+
+Dependencies
+------------
+
+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 source checkout.
+
+Testing
+-------
+
+Check the test suite by running:
+
+ make check
+
+Generate a coverage report by running:
+
+ make cover
+
+Please report any problems to the developer's mailing list.
+
+Releasing
+---------
+
+Unix-like Systems
+~~~~~~~~~~~~~~~~~
+
+Configure the source by running:
+
+ ./configure
+
+Prepare the release artefacts by running:
+
+ make distcheck
+
+You can prepare signed release artefacts by running:
+
+ make distsign
+
+The release artefacts can be found in the root source directory.
+
+Microsoft Windows
+~~~~~~~~~~~~~~~~~
+
+Configure the source by running:
+
+ ./configure
+
+Prepare the release artefacts by running:
+
+ make dist
+
+The release artefacts can be found in the `etc/windows` directory.
+
+Until the build system has been improved, you must make sure that you run this
+command from a clean source checkout. If you do not, your test database and log
+files will be bundled up in the release artefact.
View
@@ -1,18 +1,20 @@
-Installing on Unix-like Systems
-===============================
+Apache CouchDB README.Unix
+==========================
+
+A high-level guide to Unix-like systems, inc. Mac OS X and Ubuntu.
Dependencies
------------
You will need the following installed:
- * Erlang OTP (>=R12B5) (http://erlang.org/)
- * ICU (http://icu.sourceforge.net/)
- * OpenSSL (http://www.openssl.org/)
- * Mozilla SpiderMonkey (>=1.7) (http://www.mozilla.org/js/spidermonkey/)
- * libcurl (http://curl.haxx.se/libcurl/)
- * GNU Make (http://www.gnu.org/software/make/)
- * GNU Compiler Collection (http://gcc.gnu.org/)
+ * Erlang OTP (>=R12B5) (http://erlang.org/)
+ * ICU (http://icu.sourceforge.net/)
+ * OpenSSL (http://www.openssl.org/)
+ * Mozilla SpiderMonkey (1.8) (http://www.mozilla.org/js/spidermonkey/)
+ * libcurl (http://curl.haxx.se/libcurl/)
+ * GNU Make (http://www.gnu.org/software/make/)
+ * GNU Compiler Collection (http://gcc.gnu.org/)
It is recommended that you install Erlang OTP R12B-5 or above where possible.
@@ -45,8 +47,6 @@ You will need MacPorts installed to use the `port` command.
Installing
----------
-Skip to the
-
Once you have satisfied the dependencies you should run:
./configure
@@ -75,6 +75,27 @@ If everything was successful you should see the following message:
Relax.
+First Run
+---------
+
+You can start the CouchDB server by running:
+
+ sudo -i -u couchdb couchdb
+
+This uses the `sudo` command to run the `couchdb` command as the `couchdb` user.
+
+When CouchDB starts it should eventually display the following message:
+
+ Apache CouchDB has started, time to relax.
+
+Relax.
+
+To check that everything has worked, point your web browser to:
+
+ http://127.0.0.1:5984/_utils/index.html
+
+From here you should run the test suite.
+
Security Considerations
-----------------------
Oops, something went wrong.

0 comments on commit f3303f2

Please sign in to comment.