docs: Update the README
authorEmmanuele Bassi <ebassi@linux.intel.com>
Mon, 11 Oct 2010 11:00:18 +0000 (12:00 +0100)
committerEmmanuele Bassi <ebassi@linux.intel.com>
Mon, 11 Oct 2010 11:02:16 +0000 (12:02 +0100)
Add a minimal building reference, and point to git-bz for filing
patches to Bugzilla.

README

diff --git a/README b/README
index eb2b5a2..ada90bf 100644 (file)
--- a/README
+++ b/README
@@ -93,7 +93,21 @@ License, version 2.1 or (at your option) later.
 BUILDING AND INSTALLATION
 -------------------------------------------------------------------------------
 
-See the INSTALL file.
+To build Clutter from a release tarball, the usual autotool triad should
+be followed:
+
+  $ ./configure
+  $ make
+  # make install
+
+To build Clutter from a Git clone, run the autogen.sh script instead
+of the configure one. The autogen.sh script will run the configure script
+for you, unless the NOCONFIGURE environment variable is set to a non-empty
+value.
+
+See also the wiki page:
+
+  http://wiki.clutter-project.org/wiki/BuildingClutter
 
 Clutter has additional command line options for the configure script:
 
@@ -197,6 +211,8 @@ Clutter has additional command line options for the configure script:
  --with-gles=[1.1/2.0]
         Select the GLES version (for EGL backends) (default=1.1)
 
+See also the INSTALL file generated by autotools for further information.
+
 VERSIONING
 -------------------------------------------------------------------------------
 
@@ -223,7 +239,7 @@ HACKING.backends for backend-specific implementation issues.
 
 The CODING_STYLE file contains the rules for writing code conformant to the
 style guidelines used throughout Clutter. Remember: the coding style is
-mandatory; patches not conforming to it will be rejected.
+mandatory; patches not conforming to it will be rejected by default.
 
 BUGS
 -------------------------------------------------------------------------------
@@ -268,6 +284,14 @@ Or, better, commit locally and use `git format-patch` to generate a patch
 containing authorship details, so that members of the Clutter development
 team can credit your contribution properly.
 
+Another useful tool for interacting with Git and Bugzilla is git-bz(1):
+
+  http://git.fishsoup.net/man/git-bz.html
+
+Which is available here:
+
+  http://git.fishsoup.net/cgit/git-bz/
+
 RELEASE NOTES
 -------------------------------------------------------------------------------