Skip to content

Restructure dirs #184

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 5 commits into from
Jan 9, 2013
Merged

Restructure dirs #184

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0e7cd26
Moved the HTTP examples to contrib/http_examples; moved libs/network/…
glynos Jan 2, 2013
1ef781f
Added gtest as a submodule.
glynos Jan 5, 2013
8a48c83
Updated project to use the uri submodule; updated some code in order …
glynos Jan 5, 2013
195b5a6
Configured the project to build and link properly using MSVC 2012 on …
glynos Jan 8, 2013
c08ccd8
Updated README and removed incorrect and out-of-date information.
glynos Jan 8, 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
Prev Previous commit
Updated README and removed incorrect and out-of-date information.
  • Loading branch information
@glynos
glynos committed Jan 8, 2013
commit c08ccd85f3c9456499a0876a3ab8ea0673e3e9c3
65 changes: 24 additions & 41 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,31 +33,44 @@ You can find official release packages of the library at::
Building and Installing
-----------------------

Configuring the submodules
~~~~~~~~~~~~~~~~~~~~~~~~~~

The project contains submodules for some dependencies and some
libraries. Once you have cloned cpp-netlib, you must update the
submodules:

::

$ cd ~/cpp-netlib
$ git submodule update

Building with CMake
~~~~~~~~~~~~~~~~~~~

To build the libraries and run the tests with CMake, you will need to
have CMake version 2.8 or higher installed appropriately in your
have CMake version 2.8.10 or higher installed appropriately in your
system.

::

$ cmake --version
cmake version 2.8.1
cmake version 2.8.10

Inside the cpp-netlib directory, you can issue the following statements to
configure and generate the Makefiles, and build the tests::

$ cd ~/cpp-netlib # we're assuming it's where cpp-netlib is
$ cmake -DCMAKE_BUILD_TYPE=Debug \
$ cmake ~/cpp-netlib-build \ # cmake is built out of source
> -DCMAKE_BUILD_TYPE=Debug \
> -DCMAKE_C_COMPILER=clang \
> -DCMAKE_CXX_COMPILER=clang++ \
> .

Once CMake is done with generating the Makefiles and configuring the project,
you can now build the tests and run them::

$ cd ~/cpp-netlib
$ cd ~/cpp-netlib-build
$ make
$ make test

Expand All @@ -67,42 +80,14 @@ list`_.

.. _`developers mailing list`: cpp-netlib@googlegroups.com

Building with Boost.Build
~~~~~~~~~~~~~~~~~~~~~~~~~

If you don't already have Boost.Build set up on your system, follow the steps
indicated in the Boost Getting Started Guide [#]_ -- you will particularly want
to copy the ``bjam`` executable to a directory that is already in your ``PATH``
so that you don't have to go hunting for it all the time. A good place to put it
is in ``/usr/local/bin``.

.. [#] http://www.boost.org/doc/libs/release/more/getting_started/

Building and running the tests can be as simple as doing the following::

$ cd ~/cpp-netlib
$ bjam

Doing this will already build all the tests and run them as they are built. In
case you encounter any problems and would like to report it to the developers,
please do the following::

$ cd ~/cpp-netlib
$ bjam 2>&1 >build-test.log

And then attach the ``build-test.log`` file to the email you will send to the
cpp-netlib `developers mailing list`_.

.. _`developers mailing list`: cpp-netlib@googlegroups.com

Running Tests
-------------

If you want to run the tests that come with cpp-netlib, there are a few things
you will need. These are:

* A compiler (GCC 4.x, Clang 2.8, MSVC 2008)
* A build tool (CMake [#]_ recommended, Boost.Build also an option)
* A compiler (GCC 4.7.x, Clang 2.8, MSVC 2012)
* CMake [#]_
* OpenSSL headers (optional)

.. note:: This assumes that you have cpp-netlib at the top-level of
Expand Down Expand Up @@ -136,13 +121,11 @@ would be greatly appreciated. Copious amounts of comments will be called out,
but code that is not self-explanatory typically at least requires a rationale
documentation in comments explaining "why" the code is written that way.

The main "upstream" repository is the one hosted by the original maintainer of
the project (Dean Michael Berris) at http://github.com/mikhailberis/cpp-netlib.
The "official" release repository is maintained at
http://github.com/cpp-netlib/cpp-netlib -- which is a fork of the upstream
repository. It is recommended that forks be made against the upstream repostory
and pull requests be submitted against the upstream repository so that patches
and other implementations can be curated by the original maintainer.
The main "upstream" repository and official release repository is
maintained at http://github.com/cpp-netlib/cpp-netlib. It is
recommended that forks and pull requests be submitted to the upstream
repository so that patches and other implementations can be curated by
the project administrators.

Contact and Support
-------------------
Expand Down