Skip to content

Commit c08ccd8

Browse files
committed
Updated README and removed incorrect and out-of-date information.
1 parent 195b5a6 commit c08ccd8

File tree

1 file changed

+24
-41
lines changed

1 file changed

+24
-41
lines changed

README.rst

+24-41
Original file line numberDiff line numberDiff line change
@@ -33,31 +33,44 @@ You can find official release packages of the library at::
3333
Building and Installing
3434
-----------------------
3535

36+
Configuring the submodules
37+
~~~~~~~~~~~~~~~~~~~~~~~~~~
38+
39+
The project contains submodules for some dependencies and some
40+
libraries. Once you have cloned cpp-netlib, you must update the
41+
submodules:
42+
43+
::
44+
45+
$ cd ~/cpp-netlib
46+
$ git submodule update
47+
3648
Building with CMake
3749
~~~~~~~~~~~~~~~~~~~
3850

3951
To build the libraries and run the tests with CMake, you will need to
40-
have CMake version 2.8 or higher installed appropriately in your
52+
have CMake version 2.8.10 or higher installed appropriately in your
4153
system.
4254

4355
::
4456

4557
$ cmake --version
46-
cmake version 2.8.1
58+
cmake version 2.8.10
4759

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

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

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

60-
$ cd ~/cpp-netlib
73+
$ cd ~/cpp-netlib-build
6174
$ make
6275
$ make test
6376

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

6881
.. _`developers mailing list`: [email protected]
6982

70-
Building with Boost.Build
71-
~~~~~~~~~~~~~~~~~~~~~~~~~
72-
73-
If you don't already have Boost.Build set up on your system, follow the steps
74-
indicated in the Boost Getting Started Guide [#]_ -- you will particularly want
75-
to copy the ``bjam`` executable to a directory that is already in your ``PATH``
76-
so that you don't have to go hunting for it all the time. A good place to put it
77-
is in ``/usr/local/bin``.
78-
79-
.. [#] http://www.boost.org/doc/libs/release/more/getting_started/
80-
81-
Building and running the tests can be as simple as doing the following::
82-
83-
$ cd ~/cpp-netlib
84-
$ bjam
85-
86-
Doing this will already build all the tests and run them as they are built. In
87-
case you encounter any problems and would like to report it to the developers,
88-
please do the following::
89-
90-
$ cd ~/cpp-netlib
91-
$ bjam 2>&1 >build-test.log
92-
93-
And then attach the ``build-test.log`` file to the email you will send to the
94-
cpp-netlib `developers mailing list`_.
95-
96-
.. _`developers mailing list`: [email protected]
97-
9883
Running Tests
9984
-------------
10085

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

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

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

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

147130
Contact and Support
148131
-------------------

0 commit comments

Comments
 (0)