updated link for documentation and added more info to osx build #5259
Conversation
|
@kawohl, thanks for your PR! By analyzing the history of the files in this pull request, we identified @danimo, @felixboehm and @carlaschroder to be potential reviewers. |
| @@ -234,6 +241,7 @@ To build the most up-to-date version of the client: | |||
| .. note:: On Mac OS X, you need to specify ``-DCMAKE_INSTALL_PREFIX=target``, | |||
| where ``target`` is a private location, i.e. in parallel to your build | |||
| dir by specifying ``../install``. | |||
| .. note:: Example:: cmake -DCMAKE_PREFIX_PATH=/usr/local/opt/qt5 -DCMAKE_INSTALL_PREFIX=/Users/path/to/client/install/ -D_OPENSSL_LIBDIR=/usr/local/opt/openssl/lib/ -D_OPENSSL_INCLUDEDIR=/usr/local/opt/openssl/include/ -D_OPENSSL_VERSION=1.0.2a -DOPENSSL_INCLUDE_DIR=/usr/local/opt/openssl/include/ -DNO_SHIBBOLETH=1 | |||
|
|
|||
There was a problem hiding this comment.
Do you want to add some info that you could/should have QtKeyChain to the same CMAKE_INSTALL_PREFIX?
added installation info on qtkeychain
This reverts commit 4f1feab.
|
👍 for correct spelling and grammar. yay updated build docs! |
Says the CI above.. |
| 1. Install Xcode | ||
| 2. Install Xcode command line tools:: | ||
| xcode-select --install | ||
|
|
There was a problem hiding this comment.
You need an empty line between 'Install Xcode command line tools::' and 'xcode-select --install' for the markup to render the code blocks correctly.
There was a problem hiding this comment.
Click the View button if you want to see how it looks.
|
|
||
| 3. Install homebrew:: | ||
| /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" | ||
|
|
There was a problem hiding this comment.
You need an empty line between 'Install homebrew::' and the command for the markup to render the code blocks correctly.
| @@ -234,6 +244,10 @@ To build the most up-to-date version of the client: | |||
| .. note:: On Mac OS X, you need to specify ``-DCMAKE_INSTALL_PREFIX=target``, | |||
| where ``target`` is a private location, i.e. in parallel to your build | |||
| dir by specifying ``../install``. | |||
|
|
|||
| ..note:: qtkeychain must be compiled with the same prefix e.g CMAKE_INSTALL_PREFIX=/Users/path/to/client/install/ | |||
There was a problem hiding this comment.
You need a space between the two leading dots and note in '..note::'
Three notes in a row means maybe there are too many notes :) Not everything needs to be a note.
|
Thanks for reviewing! |
|
I think you need to backport to 2.2. |
|
The milestone is 2.3, but the readme is updated to say 2.2. |
I have just updated the link to the documentation to the proper version, and added some verboseness in the osx documentation