summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorNoah Slater <nslater@apache.org>2008-03-31 00:46:38 +0000
committerNoah Slater <nslater@apache.org>2008-03-31 00:46:38 +0000
commit1994d87d0af8297c90aeb26316ecc25159bda5df (patch)
tree8f5676d66b8612febbcdebfaff0484df730a0018 /README
parent521213dd1bff982796c46b289b14b1fbb3a47a07 (diff)
moved DEVELOPMENT into README and removed TROUBLESHOOTING
git-svn-id: https://svn.apache.org/repos/asf/incubator/couchdb/trunk@642848 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'README')
-rw-r--r--README36
1 files changed, 36 insertions, 0 deletions
diff --git a/README b/README
index 5205ef67..8be1f3d6 100644
--- a/README
+++ b/README
@@ -233,6 +233,42 @@ your system wide `/Library/LaunchDaemons` directory.
Windows documentation is incomplete. Please submit suggestions.
+## Development ##
+
+### Reconfiguring the Build System ###
+
+If you have edited any of the files used by the build system, such as the
+`Makefile.am` files, you will need to reconfigure your source.
+
+To reconfigure the source run the following command from the root directory:
+
+ autoreconf && ./confgure
+
+### Checking In Changes ###
+
+If your source directory has been configured or built you will need to clean
+the generated files before checking into the repository by running the
+following command:
+
+ make local-clean
+
+If everything was successful you should now have a pristine checkout.
+
+### Preparing For Distribution ###
+
+To build the source for distribution you should then run the following command:
+
+ ./configure && make distcheck
+
+If everything was successful you should see a `zip` file and/or a `tar.gz` file
+sitting in the root directory ready for distribution.
+
+### Release Checklist ###
+
+ 1. Update the `README` file with important information.
+ 2. Update the `NEWS` file with change information.
+ 3. Update the `acinclude.m4` file with version information.
+
[01]: http://www.gnu.org/software/automake/
[02]: http://www.gnu.org/software/autoconf/
[03]: http://www.gnu.org/software/libtool/