Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 100 lines (57 sloc) 2.215 kb
f3303f2 @nslater documentation improvements
nslater authored
1 Apache CouchDB DEVELOPERS
2 =========================
3
4 Only follow these instructions if you are building from a source checkout.
5
6 If you're unsure what this means, ignore this document.
7
8 Dependencies
9 ------------
10
11 You will need the following installed:
12
13 * GNU Automake (>=1.6.3) (http://www.gnu.org/software/automake/)
14 * GNU Autoconf (>=2.59) (http://www.gnu.org/software/autoconf/)
15 * GNU Libtool (http://www.gnu.org/software/libtool/)
16 * GNU help2man (http://www.gnu.org/software/help2man/)
17
18 The `help2man` tool is optional, but will generate `man` pages for you.
19
20 Debian-based (inc. Ubuntu) Systems
21 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22
23 You can install the dependencies by running:
24
25 apt-get install automake autoconf libtool help2man
26
27 Be sure to update the version numbers to match your system's available packages.
28
29 Mac OS X
30 ~~~~~~~~
31
32 You can install the dependencies by running:
33
34 port install automake autoconf libtool help2man
35
36 You will need MacPorts installed to use the `port` command.
37
38 Bootstrapping
39 -------------
40
41 Bootstrap the pristine source by running:
42
43 ./bootstrap
44
45 You must repeat this step every time you update your source checkout.
46
47 Testing
48 -------
49
50 Check the test suite by running:
51
52 make check
53
54 Generate a coverage report by running:
55
56 make cover
57
58 Please report any problems to the developer's mailing list.
59
60 Releasing
61 ---------
62
a9de8c7 @tilgovi add link to release procedure in DEVELOPERS file
tilgovi authored
63 The release procedure is documented in the project wiki:
64
65 https://wiki.apache.org/couchdb/Release_procedure
66
f3303f2 @nslater documentation improvements
nslater authored
67 Unix-like Systems
68 ~~~~~~~~~~~~~~~~~
69
70 Configure the source by running:
71
72 ./configure
73
74 Prepare the release artefacts by running:
75
76 make distcheck
77
78 You can prepare signed release artefacts by running:
79
80 make distsign
81
82 The release artefacts can be found in the root source directory.
83
84 Microsoft Windows
85 ~~~~~~~~~~~~~~~~~
86
87 Configure the source by running:
88
89 ./configure
90
91 Prepare the release artefacts by running:
92
93 make dist
94
95 The release artefacts can be found in the `etc/windows` directory.
96
97 Until the build system has been improved, you must make sure that you run this
98 command from a clean source checkout. If you do not, your test database and log
99 files will be bundled up in the release artefact.
Something went wrong with that request. Please try again.