@@ -33,31 +33,44 @@ You can find official release packages of the library at::
33
33
Building and Installing
34
34
-----------------------
35
35
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
+
36
48
Building with CMake
37
49
~~~~~~~~~~~~~~~~~~~
38
50
39
51
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
41
53
system.
42
54
43
55
::
44
56
45
57
$ cmake --version
46
- cmake version 2.8.1
58
+ cmake version 2.8.10
47
59
48
60
Inside the cpp-netlib directory, you can issue the following statements to
49
61
configure and generate the Makefiles, and build the tests::
50
62
51
63
$ 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 \
53
66
> -DCMAKE_C_COMPILER=clang \
54
67
> -DCMAKE_CXX_COMPILER=clang++ \
55
68
> .
56
69
57
70
Once CMake is done with generating the Makefiles and configuring the project,
58
71
you can now build the tests and run them::
59
72
60
- $ cd ~/cpp-netlib
73
+ $ cd ~/cpp-netlib-build
61
74
$ make
62
75
$ make test
63
76
@@ -67,42 +80,14 @@ list`_.
67
80
68
81
.. _
`developers mailing list` :
[email protected]
69
82
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
-
98
83
Running Tests
99
84
-------------
100
85
101
86
If you want to run the tests that come with cpp-netlib, there are a few things
102
87
you will need. These are:
103
88
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 [# ]_
106
91
* OpenSSL headers (optional)
107
92
108
93
.. 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,
136
121
but code that is not self-explanatory typically at least requires a rationale
137
122
documentation in comments explaining "why" the code is written that way.
138
123
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.
146
129
147
130
Contact and Support
148
131
-------------------
0 commit comments