@@ -13,6 +13,21 @@ Join us on Slack: http://slack.cpp-netlib.org/
1313
1414Subscribe to the mailing list: https://groups.google.com/forum/#!forum/cpp-netlib
1515
16+ Downloading cpp-netlib
17+ ----------------------
18+
19+ You can find official release packages of the library at::
20+
21+ http://github.com/cpp-netlib/cpp-netlib/downloads
22+
23+ If you want the latest code from the master branch of the project, you can
24+ follow these instructions for cloning the project repository::
25+
26+ $ git clone https://github.com/cpp-netlib/cpp-netlib
27+ $ cd cpp-netlib
28+ $ git submodule init
29+ $ git submodule update
30+
1631Introduction
1732------------
1833
@@ -35,41 +50,31 @@ This library is released under the Boost Software License (please see
3550http://boost.org/LICENSE_1_0.txt or the accompanying LICENSE_1_0.txt file
3651for the full text.
3752
38- Downloading cpp-netlib
39- ----------------------
40-
41- You can find official release packages of the library at::
42-
43- http://github.com/cpp-netlib/cpp-netlib/downloads
44-
4553Building and Installing
4654-----------------------
4755
48- Building with CMake
49- ~~~~~~~~~~~~~~~~~~~
50-
51- To build the libraries and run the tests with CMake, you will need to
52- have CMake version 2.8 or higher installed appropriately in your
53- system.
56+ To build the libraries you will need to have CMake version 2.8 or higher
57+ installed appropriately in your system.
5458
5559::
5660
5761 $ cmake --version
5862 cmake version 2.8.1
5963
60- Inside the cpp-netlib directory, youcan issue thefollowing statements to
61- configure and generate the Makefiles, and build thetests ::
64+ It is recommended that youbuild cpp-netlib outside of thesource directory, to
65+ avoid having issues with CMake generated files polluting thesource directory ::
6266
63- $ cd ~/cpp-netlib # we're assuming it's where cpp-netlib is
67+ $ mkdir ~/cpp-netlib-build
68+ $ cd ~/cpp-netlib-build
6469 $ cmake -DCMAKE_BUILD_TYPE=Debug \
6570 > -DCMAKE_C_COMPILER=clang \
6671 > -DCMAKE_CXX_COMPILER=clang++ \
67- > .
72+ > $HOME/cpp-netlib # we're assuming this is where cpp-netlib is .
6873
6974Once CMake is done with generating the Makefiles and configuring the project,
7075you can now build the tests and run them::
7176
72- $ cd ~/cpp-netlib
77+ $ cd ~/cpp-netlib-build
7378 $ make
7479 $ make test
7580
@@ -85,8 +90,8 @@ Running Tests
8590If you want to run the tests that come with cpp-netlib, there are a few things
8691you will need. These are:
8792
88- * A compiler (GCC 4.x, Clang2.8 , MSVC 2008)
89- * A build tool (CMake _recommended, Boost.Build also an option )
93+ * A compiler (GCC 4.x, Clang3.6 , MSVC 2008)
94+ * A build tool (CMake _is required )
9095 * OpenSSL headers (optional)
9196
9297..note ::This assumes that you have cpp-netlib at the top-level of
@@ -96,11 +101,13 @@ you will need. These are:
96101Hacking on cpp-netlib
97102---------------------
98103
99- cpp-netlibis being developed with the git _ distributed SCM system.
104+ cpp-netlibuses git _ for tracking work, and is hosted on GitHub _.
100105cpp-netlib is hosted onGitHub _ following the GitHub recommended practice of
101106forking the repository and submitting pull requests to the source repository.
102107You can read more about theforking _ process and submitting `pull requests `_ if
103- you're not familiar with either process yet.
108+ you're not familiar with either process yet. cpp-netib follows the GitHub pull
109+ request model for accepting patches. You can read more about the process at
110+ http://cpp-netlib.org/process.html#pull-requests.
104111
105112.. _git :http://git-scm.com/
106113.. _GitHub :http://github.com/
@@ -114,19 +121,10 @@ copyright notices are at the top of each file in the project.
114121
115122.. _`Boost Software License` :http://www.boost.org/LICENSE_1_0.txt
116123
117- At the time of writing, there are no coding conventions being followed but if
118- you write in the general style that is already existing in the project that
119- would be greatly appreciated. Copious amounts of comments will be called out,
120- but code that is not self-explanatory typically at least requires a rationale
121- documentation in comments explaining "why" the code is written that way.
122-
123- The main "upstream" repository is the one hosted by the original maintainer of
124- the project (Dean Michael Berris) at http://github.com/deanberris/cpp-netlib.
125- The "official" release repository is maintained at
126- http://github.com/cpp-netlib/cpp-netlib -- which is a fork of the upstream
127- repository. It is recommended that forks be made against the upstream repostory
128- and pull requests be submitted against the upstream repository so that patches
129- and other implementations can be curated by the original maintainer.
124+ You can read about the cpp-netlib style guide at
125+ http://cpp-netlib.org/style-guide.html.
126+
127+ The main "upstream" repository is at http://github.com/cpp-netlib/cpp-netlib.
130128
131129Contact and Support
132130-------------------