Merge pull request #340 from kaspervandenberg/0.11-devel-integration

deanberris · deanberris · commit 03e6e1398e05 · 2013-12-04T16:42:59.000-08:00
Getting started documentation
diff --git a/libs/network/doc/getting_started.rst b/libs/network/doc/getting_started.rst
@@ -159,6 +159,21 @@ Once the build has completed, you can now run the test suite by issuing::
 
     $ make test
 
+You can install :mod:`cpp-netlib` by issuing::
+
+    $ sudo make install
+
+By default this installs :mod:`cpp-netlib` into ``/usr/local``.
+
+.. note:: As of version 0.9.3, :mod:`cpp-netlib` produces three static
+   libraries.  Using GCC on Linux these are::
+
+      libcppnetlib-client-connections.a
+      libcppnetlib-server-parsers.a
+      libcppnetlib-uri.a
+
+   Users can find them in ``~/cpp-netlib-build/libs/network/src``.
+
 Building On Windows
 ~~~~~~~~~~~~~~~~~~~
 
@@ -169,19 +184,35 @@ look for the solution and project files as the artifacts of the call to
 with a number of project files for Visual Studio.
 
 .. note:: As of version 0.9.3, :mod:`cpp-netlib` produces three static
-          libraries.  Using GCC on Linux these are::
+   libraries.  Using Visual C++ on Windows they are::
+
+      cppnetlib-client-connections.lib
+      cppnetlib-server-parsers.lib
+      cppnetlib-uri.lib
+
+   Users can find them in ``~/cpp-netlib-build/libs/network/src``.
+
+Using :mod:`cpp-netlib`
+=======================
+
+CMake projects
+~~~~~~~~~~~~~~
 
-   	     libcppnetlib-client-connections.a
-	     libcppnetlib-server-parsers.a
-	     libcppnetlib-uri.a
+Projects using CMake can add the following lines in their ``CMakeLists.txt`` to
+be able to use :mod:`cpp-netlib`::
+    
+   set ( CMAKE_PREFIX_PATH ${CMAKE_PREFIX_PATH} ~/cpp-netlib-build )
+   find_package ( cppnetlib 0.11.0 REQUIRED )
+   include_directories ( ${CPPNETLIB_INCLUDE_DIRS} )
+   target_link_libraries ( MyApplication ${CPPNETLIB_LIBRARIES} )
 
-	  And using Visual C++ on Windows they are::
+.. note:: Setting ``CMAKE_PREFIX_PATH`` is only required when :mod:`cpp-netlib`
+   is not installed to a location that CMake searches.  When :mod:`cpp-netlib`
+   is installed to the default location (``/usr/local``), ``CMake`` can find it.
 
-   	     cppnetlib-client-connections.lib
-	     cppnetlib-server-parsers.lib
-	     cppnetlib-uri.lib
+.. note:: We assume that ``MyApplication`` is the application that you are 
+   building and which depends on :mod:`cpp-netlib`.
 
-	  Users can find them in ``~/cpp-netlib-build/libs/network/src``.
 
 Reporting Issues, Getting Support
 =================================
