Skip to content

Getting started documentation #340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Dec 5, 2013
Merged

Getting started documentation #340

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6abffd6
Add static library note to linux section.
kaspervandenberg Dec 2, 2013
bfbada5
Remove Linux part of note from Windows section.
kaspervandenberg Dec 2, 2013
806ba77
Copy where to find static libraries to linux section.
kaspervandenberg Dec 2, 2013
288d3fc
Make install and using cpp-netlib.
kaspervandenberg Dec 2, 2013
6efa9d6
sudo make install
kaspervandenberg Dec 3, 2013
27a7eac
Fix indent
kaspervandenberg Dec 3, 2013
8de9c5c
Merge pull request #1 from kaspervandenberg/0.11-doc
kaspervandenberg Dec 3, 2013
f623923
Correct spelling of issuing
kaspervandenberg Dec 3, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 40 additions & 9 deletions libs/network/doc/getting_started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
~~~~~~~~~~~~~~~~~~~

Expand All @@ -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
=================================
Expand Down