svn commit: r1183649 - in /avro/trunk: CHANGES.txt lang/c/ lang/c/INSTALL lang/c/README

[dc...@apache.org]

Author: dcreager
Date: Sat Oct 15 14:32:45 2011
New Revision: 1183649

URL: http://svn.apache.org/viewvc?rev=1183649&view=rev
Log:
AVRO-468. C: Document CMake build system

Added:
    avro/trunk/lang/c/INSTALL
Modified:
    avro/trunk/CHANGES.txt
    avro/trunk/lang/c/   (props changed)
    avro/trunk/lang/c/README

Modified: avro/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/avro/trunk/CHANGES.txt?rev=1183649&r1=1183648&r2=1183649&view=diff
==============================================================================
--- avro/trunk/CHANGES.txt (original)
+++ avro/trunk/CHANGES.txt Sat Oct 15 14:32:45 2011
@@ -38,6 +38,8 @@ Avro 1.6.0 (unreleased)
     AVRO-929. C: Set install_name in shared library on Mac OS OX.
     (dcreager)
 
+    AVRO-468. C: Document CMake build scripts. (dcreager)
+
     AVRO-474. C: Added source package target to CMake build scripts.
     (dcreager)
 

Propchange: avro/trunk/lang/c/
------------------------------------------------------------------------------
--- svn:ignore (original)
+++ svn:ignore Sat Oct 15 14:32:45 2011
@@ -13,5 +13,4 @@ libtool
 stamp-h1
 *.lo
 *.o
-INSTALL
 .deps

Added: avro/trunk/lang/c/INSTALL
URL: http://svn.apache.org/viewvc/avro/trunk/lang/c/INSTALL?rev=1183649&view=auto
==============================================================================
--- avro/trunk/lang/c/INSTALL (added)
+++ avro/trunk/lang/c/INSTALL Sat Oct 15 14:32:45 2011
@@ -0,0 +1,41 @@
+Installation instructions
+=========================
+
+The Avro library is written in ANSI C.  It uses cmake as its build
+manager.
+
+
+Prerequisites
+-------------
+
+Avro doesn't have any prerequisite libraries, but you need asciidoc [1]
+and source-highlight [2] installed to build Avro's documentation.  The
+build scripts will automatically detect whether these tools are
+installed, and will skip the documentation if they're not.
+
+[1] http://www.methods.co.nz/asciidoc
+[2] http://www.gnu.org/software/src-highlite/
+
+
+Building from source
+--------------------
+
+The swanson language uses cmake as its build manager.  In most cases,
+you should be able to build the source code using the following:
+
+    $ mkdir build
+    $ cd build
+    $ cmake .. \
+        -DCMAKE_INSTALL_PREFIX=$PREFIX \
+        -DCMAKE_BUILD_TYPE=RelWithDebInfo
+    $ make
+    $ make test
+    $ make install
+
+You might have to run the last command using sudo, if you need
+administrative privileges to write to the $PREFIX directory.
+
+The "RelWithDebInfo" build type will build an optimized copy of the
+library, including debugging symbols.  Use the "Release" build type if
+you don't want debugging symbols.  Use the "Debug" build type if you
+want a non-optimized library, with debugging symbols.

Modified: avro/trunk/lang/c/README
URL: http://svn.apache.org/viewvc/avro/trunk/lang/c/README?rev=1183649&r1=1183648&r2=1183649&view=diff
==============================================================================
--- avro/trunk/lang/c/README (original)
+++ avro/trunk/lang/c/README Sat Oct 15 14:32:45 2011
@@ -5,4 +5,6 @@
 /_/  |_|___/_/   \____/   \____/   
 
 ======================================================
-Please see the documentation in the "docs" directory.
+Please see the INSTALL file for installation instructions, and the
+documentation in the "docs" directory for more details about the
+library.