summaryrefslogtreecommitdiff
path: root/DEVELOPMENT
diff options
context:
space:
mode:
authorNoah Slater <nslater@apache.org>2008-03-30 02:14:29 +0000
committerNoah Slater <nslater@apache.org>2008-03-30 02:14:29 +0000
commitc17bae2a8607479a9f8df7fc9e6defde2078909f (patch)
tree454a25ea60bba0a861a7edf5ed7657f76a2e24af /DEVELOPMENT
parenta14b46824adcc717573391ec403ba4ce401d5772 (diff)
rewrote and improved core documentation for clarity, utility and compatibility with Markdown
git-svn-id: https://svn.apache.org/repos/asf/incubator/couchdb/trunk@642660 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'DEVELOPMENT')
-rw-r--r--DEVELOPMENT35
1 files changed, 35 insertions, 0 deletions
diff --git a/DEVELOPMENT b/DEVELOPMENT
new file mode 100644
index 00000000..98278ede
--- /dev/null
+++ b/DEVELOPMENT
@@ -0,0 +1,35 @@
+# 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.