Getting started documentation #340
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Some Linux users might skip the Windows build section and thus miss the note about the static libraries. Therefore, copy the note about the static libraries to the Linux build section.
- Now that the Linux section contains a note about the generated static libraries, in the Windows section the part of the note, about which libraries are generated under Linux, is redundant. Therefore, remove it.
- Forgot to copy this part of the note in commit #6abffd6.
- Add make install command - Add section about how to use cpp-netlib from a CMakeLists.txt.
| @@ -159,6 +159,21 @@ Once the build has completed, you can now run the test suite by issuing:: | |||
|
|
|||
| $ make test | |||
|
|
|||
| You can install :mod:`cpp-netlib` by issueing *as root*:: | |||
|
|
|||
| $ make install | |||
There was a problem hiding this comment.
Can you instead say 'sudo make install' here?
ghost
assigned
|
Thanks @kaspervandenberg -- this is very well written! Just a few comments that hopefully you can address too so we can merge it in. It would also be good once you've made the changes to also do a PR of the generated Sphinx docs. |
- Notes use three spacesr; - Code (libraries) within notes uses six spaces; and - No tabs.
|
LGTM -- thanks @kaspervandenberg ! |
deanberris
added a commit
that referenced
this pull request
Dec 5, 2013
Getting started documentation
leecoder
pushed a commit
to leecoder/cpp-netlib
that referenced
this pull request
Apr 14, 2015
…tegration Getting started documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
-- Kasper van den Berg