You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by ro...@apache.org on 2015/03/24 17:43:51 UTC

couchdb commit: updated refs/heads/master to d881dcf

Repository: couchdb
Updated Branches:
  refs/heads/master 2d10bfd64 -> d881dcf5a


doc: explain new workflow for developing

PR: #270
PR-URL: https://github.com/apache/couchdb/pull/270
Reviewed-By: Paul J. Davis <pa...@gmail.com>
Reviewed-By: Alexander Shorin <kx...@apache.org>


Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/d881dcf5
Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/d881dcf5
Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/d881dcf5

Branch: refs/heads/master
Commit: d881dcf5ac990c44d00b2cd49c0e4ff67ae861c5
Parents: 2d10bfd
Author: Robert Kowalski <ro...@kowalski.gd>
Authored: Wed Oct 8 14:52:07 2014 +0200
Committer: Robert Kowalski <ro...@apache.org>
Committed: Tue Mar 24 17:44:03 2015 +0100

----------------------------------------------------------------------
 README.rst | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb/blob/d881dcf5/README.rst
----------------------------------------------------------------------
diff --git a/README.rst b/README.rst
index 9a43aa8..ad5fb87 100644
--- a/README.rst
+++ b/README.rst
@@ -67,9 +67,25 @@ Read more about JSpec here:
 When you change the specs, but your changes have no effect, manually reload
 the changed spec file in the browser. When the spec that tests Erlang views
 fails, make sure you have enabled Erlang views as described here:
-   
+
        http://wiki.apache.org/couchdb/EnableErlangViews
 
+Getting started with developing
+-------------------------------
+
+Basically you just have to install the needed dependencies which are
+documented in the install docs and then run `./configure && make`.
+
+You don't need to run `make install` after compiling, just use
+`./dev/run` to spin up three nodes. There is a haproxy config file in `./rel`.
+Just run: `cd rel && haproxy -f haproxy.cfg`. You will now have a local
+cluster listening on port `5984`.
+
+For Fauxton developers fixing the admin-party does not work via the button in
+Fauxton. To fix the admin party you have to run `./dev/run` with the `admin`
+flag, e.g. `./dev/run --admin=username:password`. If you want to have an
+admin-party, just omit the flag.
+
 Cryptographic Software Notice
 -----------------------------