Repository: couchdb Updated Branches: refs/heads/master 1ef7182ac -> ce2c357fb
Adding references for FreeBSD, Fauxton, minor cleanup Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/ce2c357f Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/ce2c357f Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/ce2c357f Branch: refs/heads/master Commit: ce2c357fbb3402b79c7a7c01dcc40b1f2ff55487 Parents: 1ef7182 Author: Joan Touzet <woh...@apache.org> Authored: Fri Jun 26 17:58:59 2015 -0400 Committer: Joan Touzet <woh...@apache.org> Committed: Fri Jun 26 17:58:59 2015 -0400 ---------------------------------------------------------------------- INSTALL.Unix | 56 ++++++++++++++++++++----------------------------------- README-DEV | 42 ++++++++++++++++++----------------------- 2 files changed, 38 insertions(+), 60 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/couchdb/blob/ce2c357f/INSTALL.Unix ---------------------------------------------------------------------- diff --git a/INSTALL.Unix b/INSTALL.Unix index f662e63..8b4b53d 100644 --- a/INSTALL.Unix +++ b/INSTALL.Unix @@ -61,17 +61,10 @@ Debian-based Systems You can install the dependencies by running: - sudo apt-get install build-essential - sudo apt-get install erlang-base-hipe - sudo apt-get install erlang-dev - sudo apt-get install erlang-manpages - sudo apt-get install erlang-eunit - sudo apt-get install erlang-nox - sudo apt-get install libicu-dev - sudo apt-get install libmozjs185-dev - sudo apt-get install libcurl4-openssl-dev - sudo apt-get install pkg-config - sudo apt-get install rebar + sudo apt-get install build-essential erlang-base-hipe \ + erlang-dev erlang-manpages erlang-eunit erlang-nox \ + libicu-dev libmozjs185-dev libcurl4-openssl-dev \ + pkg-config rebar There are lots of Erlang packages. If there is a problem with your install, try a different mix. There is more information on the @@ -95,21 +88,10 @@ RedHat-based (Fedora, Centos, RHEL) Systems You can install the dependencies by running: - sudo yum install autoconf - sudo yum install autoconf-archive - sudo yum install automake - sudo yum install curl-devel - sudo yum install erlang-asn1 - sudo yum install erlang-erts - sudo yum install erlang-eunit - sudo yum install erlang-os_mon - sudo yum install erlang-xmerl - sudo yum install erlang-rebar - sudo yum install help2man - sudo yum install js-devel - sudo yum install libicu-devel - sudo yum install libtool - sudo yum install perl-Test-Harness + sudo yum install autoconf autoconf-archive automake \ + curl-devel erlang-asn1 erlang-erts erlang-eunit \ + erlang-os_mon erlang-xmerl erlang-rebar help2man \ + js-devel libicu-devel libtool perl-Test-Harness While CouchDB builds against the default js-devel-1.7.0 included in some distributions, it's recommended to use a more recent @@ -125,16 +107,8 @@ the Command Line Tools: You can then install the other dependencies by running: - brew install autoconf - brew install autoconf-archive - brew install automake - brew install libtool - brew install erlang - brew install icu4c - brew install spidermonkey - brew install curl - brew install pkg-config - brew install rebar + brew install autoconf autoconf-archive automake libtool \ + erlang icu4c spidermonkey curl pkg-config rebar You will need Homebrew installed to use the `brew` command. @@ -148,6 +122,16 @@ a segmentation fault or a bus error, you will need to install your own version of OpenSSL. See the troubleshooting guide, mentioned above, for more information. +FreeBSD +------- + +FreeBSD requires the use of GNU Make. Where `make` is specified in this +documentation, substitute `gmake`. + +You can install this by running: + + pkg install gmake + Installing ---------- http://git-wip-us.apache.org/repos/asf/couchdb/blob/ce2c357f/README-DEV ---------------------------------------------------------------------- diff --git a/README-DEV b/README-DEV index 94bb683..997e3db 100644 --- a/README-DEV +++ b/README-DEV @@ -39,6 +39,11 @@ However, you do not need them if: * You are building from a distribution archive, or * You don't care about building the documentation +If you intend to build Fauxton, you will also need to install its +dependencies. After running ./configure to download all of the +dependent repositories, you can read about required dependencies in +`src/fauxton/readme.md`. Typically, installing npm and node.js are +sufficient to enable a Fauxton build. Here is a list of *optional* dependencies for various operating systems. Installation will be easiest, when you install them all. @@ -46,36 +51,21 @@ Installation will be easiest, when you install them all. Debian-based (inc. Ubuntu) Systems ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - sudo apt-get install help2man - sudo apt-get install python-sphinx - sudo apt-get install texlive-latex-base - sudo apt-get install texlive-latex-recommended - sudo apt-get install texlive-latex-extra - sudo apt-get install texlive-fonts-recommended - sudo apt-get install texinfo - sudo apt-get install gnupg + sudo apt-get install help2man python-sphinx \ + texlive-latex-base texlive-latex-recommended \ + texlive-latex-extra texlive-fonts-recommended texinfo gnupg Gentoo-based Systems ~~~~~~~~~~~~~~~~~~~~ - sudo emerge texinfo - sudo emerge gnupg - sudo emerge coreutils - sudo emerge pkgconfig - sudo emerge help2man + sudo emerge texinfo gnupg coreutils pkgconfig help2man sudo USE=latex emerge sphinx RedHat-based (Fedora, Centos, RHEL) Systems ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - sudo yum install help2man - sudo yum install python-sphinx - sudo yum install python-docutils - sudo yum install python-pygments - sudo yum install texlive-latex - sudo yum install texlive-latex-fonts - sudo yum install texinfo - sudo yum install gnupg + sudo yum install help2man python-sphinx python-docutils \ + python-pygments texlive-latex texlive-latex-fonts texinfo gnupg Mac OS X ~~~~~~~~ @@ -88,9 +78,7 @@ Unless you want to install the optional dependencies, skip to the next section. Install what else we can with Homebrew: - brew install help2man - brew install gnupg - brew install md5sha1sum + brew install help2man gnupg md5sha1sum If you don't already have pip installed, install it: @@ -108,6 +96,12 @@ Download MaxTeX from here: Follow the instructions to get a working LaTeX install on your system. +FreeBSD +------- + + + pkg install help2man texinfo gnupg py27-sphinx texlive-full tex-formats + Windows ~~~~~~~