Skip to content

Commit 288d3fc

Browse files
Make install and using cpp-netlib.
- Add make install command - Add section about how to use cpp-netlib from a CMakeLists.txt.
1 parent 806ba77 commit 288d3fc

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

libs/network/doc/getting_started.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,12 @@ Once the build has completed, you can now run the test suite by issuing::
159159

160160
$ make test
161161

162+
You can install :mod:`cpp-netlib` by issueing *as root*::
163+
164+
$ make install
165+
166+
By default this installs :mod:`cpp-netlib` into ``/usr/local``.
167+
162168
.. note:: As of version 0.9.3, :mod:`cpp-netlib` produces three static
163169
libraries. Using GCC on Linux these are::
164170

@@ -186,6 +192,29 @@ with a number of project files for Visual Studio.
186192

187193
Users can find them in ``~/cpp-netlib-build/libs/network/src``.
188194

195+
Using :mod:`cpp-netlib`
196+
=======================
197+
198+
CMake projects
199+
~~~~~~~~~~~~~~
200+
201+
Projects using CMake can add the following lines in their ``CMakeLists.txt`` to
202+
be able to use :mod:`cpp-netlib`::
203+
204+
set ( CMAKE_PREFIX_PATH ${CMAKE_PREFIX_PATH} ~/cpp-netlib-build )
205+
find_package ( cppnetlib 0.11.0 REQUIRED )
206+
include_directories ( ${CPPNETLIB_INCLUDE_DIRS} )
207+
target_link_libraries ( MyApplication ${CPPNETLIB_LIBRARIES} )
208+
209+
.. note:: Setting ``CMAKE_PREFIX_PATH`` is only required when :mod:`cpp-netlib`
210+
is not installed to a location that CMake searches. When
211+
:mod:`cpp-netlib` is installed to the default location
212+
(``/usr/local``), ``CMake`` can find it.
213+
214+
.. note:: We assume that ``MyApplication`` is the application that you are
215+
building and which depends on :mod:`cpp-netlib`.
216+
217+
189218
Reporting Issues, Getting Support
190219
=================================
191220

0 commit comments

Comments
 (0)