Repository: couchdb Updated Branches: refs/heads/master 7ff310bcd -> 487df372d
Fix inaccuracies in README files Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/487df372 Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/487df372 Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/487df372 Branch: refs/heads/master Commit: 487df372d8ca8c45138da34dc3fe65f124c1d0dc Parents: 7ff310b Author: Joan Touzet <woh...@apache.org> Authored: Sat Aug 27 04:10:44 2016 -0400 Committer: Joan Touzet <woh...@apache.org> Committed: Sat Aug 27 04:10:44 2016 -0400 ---------------------------------------------------------------------- README-DEV.rst | 28 ++++++++++++++-------------- README.rst | 37 ++++++++++++------------------------- 2 files changed, 26 insertions(+), 39 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/couchdb/blob/487df372/README-DEV.rst ---------------------------------------------------------------------- diff --git a/README-DEV.rst b/README-DEV.rst index 1235689..a8cfbd3 100644 --- a/README-DEV.rst +++ b/README-DEV.rst @@ -218,30 +218,30 @@ Releasing The release procedure is documented here:: - https://wiki.apache.org/couchdb/Release_Procedure + https://cwiki.apache.org/confluence/display/COUCHDB/Release+Procedure Unix-like Systems ~~~~~~~~~~~~~~~~~ -Prepare the release artifacts by running:: +A release tarball can be built by running:: - make distcheck + make dist -You can prepare signed release artifacts by running:: +An Erlang CouchDB release includes the full Erlang Run Time System and +all dependent applications necessary to run CouchDB, standalone. The +release created is completely relocatable on the file system, and is +the recommended way to distribute binaries of CouchDB. A release can be +built by running:: - make distsign + make release -The release artifacts can be found in the root source directory. +The release can then be found in the rel/couchdb directory. Microsoft Windows ~~~~~~~~~~~~~~~~~ -Prepare the release artifacts by running:: - - make dist - -The release artifacts can be found in the `etc/windows` directory. +The release tarball and Erlang CouchDB release commands work on +Microsoft Windows the same as they do on Unix-like systems. To create +a full installer, the separate couchdb-glazier repository is required. +Full instructions are available in that repository's README file. -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 artifacts. http://git-wip-us.apache.org/repos/asf/couchdb/blob/487df372/README.rst ---------------------------------------------------------------------- diff --git a/README.rst b/README.rst index b136aaa..611b2f5 100644 --- a/README.rst +++ b/README.rst @@ -27,13 +27,9 @@ They include a changelog: http://docs.couchdb.org/en/latest/changelog.html -For troubleshooting, see: +For troubleshooting or cryptic error messages, see: - http://wiki.apache.org/couchdb/Troubleshooting - -If you're getting a cryptic error message, see: - - http://wiki.apache.org/couchdb/Error_messages + http://docs.couchdb.org/en/latest/install/troubleshooting.html For general help, see: @@ -47,35 +43,26 @@ The mailing lists provide a wealth of support and knowledge for you to tap into. Feel free to drop by with your questions or discussion. See the official CouchDB website for more information about our community resources. -Running the Testsuite ---------------------- - -Run the testsuite for couch.js and jquery.couch.js by browsing here: - - http://127.0.0.1:5984/_utils/spec/run.html +Verifying your Installation +--------------------------- -It should work in at least Firefox >= 3.6 with Private Browsing mode enabled. +Run a basic test suite for CouchDB by browsing here: -Read more about JSpec here: - - https://github.com/liblime/jspec - -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 + http://127.0.0.1:5984/_utils/#verifyinstall Getting started with developing ------------------------------- +For more detail, read the README-DEV.rst file in this directory. + 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`. +`./dev/run` to spin up three nodes. You can add haproxy as a caching +layer in front of this cluster by running `./dev/run --with-haproxy +--haproxy=/path/to/haproxy` . 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`
