Add build documentation to README.dev.md #113
Merged
Conversation
This file contains 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
fdiblen
reviewed
Mar 7, 2022
README.dev.md
Outdated
| @@ -66,7 +126,7 @@ After a pull request is created, a Codacy test should appear. Follow the link th | |||
|
|
|||
| #### pre-commit hooks | |||
There was a problem hiding this comment.
Suggested change
| #### pre-commit hooks | |
| #### pre-commit hooks (optional) |
fdiblen
reviewed
Mar 7, 2022
README.dev.md
Outdated
| - `gcc` 9 or above | ||
| - `g++` 9 or above | ||
| - `make` 4 or above | ||
| - `cmake` 3.22 or above |
There was a problem hiding this comment.
Suggested change
| - `cmake` 3.22 or above | |
| - `cmake` 3.17 or above |
fdiblen
reviewed
Mar 7, 2022
|
|
||
| For instance, the commands below download install CMake 3.22. | ||
|
|
||
| ```shell |
There was a problem hiding this comment.
can we just point to official documentation at https://cmake.org/install/ ?
fdiblen
reviewed
Mar 7, 2022
README.dev.md
Outdated
| sudo make install | ||
| ``` | ||
|
|
||
| If you can't run `sudo` to install `cmake` - for instance if you are in a cluster without privileges - you should add the path to the CMake `bin` folder to your path. |
There was a problem hiding this comment.
Normal user needs to use CMAKE_INSTALL_PREFIX flag. Can we point to the official documentation at https://cmake.org/cmake/help/v3.22/variable/CMAKE_INSTALL_PREFIX.html?
fdiblen
suggested changes
Mar 7, 2022
|
Hi @fdiblen, thanks for the review. I have updated the pull request with your comments. |
abelsiqueira
force-pushed
the
33-build-doc
branch
from
679512a
to
4e7e436
Compare
|
I have updated again |
fdiblen
approved these changes
Mar 7, 2022
|
Thanks for reviewing 🏟️ |
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.
Description
Add developer documentation to be able to build the library.
Related issues:
Instructions to review the pull request
Review online.