Skip to content

Commit 79e695d

Browse files
committed
More formatting changes to README.
1 parent 2530d37 commit 79e695d

File tree

1 file changed

+21
-13
lines changed

1 file changed

+21
-13
lines changed

README.rst

+21-13
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,8 @@ where cpp-netlib is installed as part of the include paths.
4141

4242
.. [#] http://www.boost.org/
4343
44-
The recommended installation procedure would be to follow the steps below:
44+
The recommended installation procedure would be to follow the steps below::
4545

46-
::
4746
# On Linux/Mac, consider the `$` character as the shell prompt
4847
$ sudo mkdir -p /usr/local/include/cpp-netlib
4948
$ sudo cp -r cpp-netlib/boost /usr/local/include/cpp-netlib
@@ -100,10 +99,10 @@ you can now build the tests and run them::
10099
$ make test
101100

102101
If for some reason some of the tests fail, you can send the files in
103-
``Testing/Temporary/`` as attachments to the cpp-netlib developers mailing list
104-
[#]_.
102+
``Testing/Temporary/`` as attachments to the cpp-netlib `developers mailing
103+
list`_.
105104

106-
.. [#] https://lists.sourceforge.net/lists/listinfo/cpp-netlib-devel
105+
.. _`developers mailing list`: https://lists.sourceforge.net/lists/listinfo/cpp-netlib-devel
107106

108107
Building with Boost.Build
109108
~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -129,25 +128,31 @@ please do the following::
129128
$ bjam 2>&1 >build-test.log
130129

131130
And then attach the ``build-test.log`` file to the email you will send to the
132-
cpp-netlib developers mailing list [#]_.
131+
cpp-netlib `developers mailing list`_.
133132

134-
.. [#] https://lists.sourceforge.net/lists/listinfo/cpp-netlib-devel
133+
.. _`developers mailing list`: https://lists.sourceforge.net/lists/listinfo/cpp-netlib-devel
135134

136135
Hacking on cpp-netlib
137136
---------------------
138137

139-
cpp-netlib is being developed with the git [#]_ distributed SCM system.
140-
cpp-netlib is hosted on GitHub [#]_ following the GitHub recommended practice of
138+
cpp-netlib is being developed with the git_ distributed SCM system.
139+
cpp-netlib is hosted on GitHub_ following the GitHub recommended practice of
141140
forking the repository and submitting pull requests to the source repository.
142-
You can read more about `the forking process<http://help.github.com/forking/>`
143-
and `submitting pull requests<http://help.github.com/pull-requests/>` if
141+
You can read more about the forking_ process and submitting `pull requests`_ if
144142
you're not familiar with either process yet.
145143

146-
Because cpp-netlib is released under the Boost Software License [#]_ it is
144+
.. _git: http://git-scm.com/
145+
.. _GitHub: http://github.com/
146+
.. _forking: http://help.github.com/forking/
147+
.. _`pull requests`: http://help.github.com/pull-requests/
148+
149+
Because cpp-netlib is released under the `Boost Software License`_ it is
147150
recommended that any file you make changes to bear your copyright notice
148151
alongside the original authors' copyright notices on the file. Typically the
149152
copyright notices are at the top of each file in the project.
150153

154+
.. _`Boost Software License`: http://www.boost.org/LICENSE_1_0.txt
155+
151156
At the time of writing, there are no coding conventions being followed but if
152157
you write in the general style that is already existing in the project that
153158
would be greatly appreciated. Copious amounts of comments will be called out,
@@ -166,9 +171,12 @@ Contact and Commercial Support
166171
------------------------------
167172

168173
In case you have any questions or would like to make feature requests, you can
169-
contact the development team through the `developers mailing list<https://lists.sourceforge.net/lists/listinfo/cpp-netlib-devel>`
174+
contact the development team through the `developers mailing list`_
170175
or by filing issues at http://github.com/mikhailberis/cpp-netlib/issues.
171176

177+
.. _`developers mailing list`:
178+
https://lists.sourceforge.net/lists/listinfo/cpp-netlib-devel
179+
172180
You can reach the maintainers of the project through::
173181

174182
Dean Michael Berris

0 commit comments

Comments
 (0)