Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Compilation-Guide.md with --recursive clone and ARM flag #3

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 3 additions & 9 deletions doc/Compilation-Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ For IQ-TREE version 1 please use:

Alternatively, if you have `git` installed, you can also clone the source code from GitHub with:

git clone https://github.com/iqtree/iqtree2.git
git clone --recursive https://github.com/iqtree/iqtree2.git

For IQ-TREE version 1 please clone:

Expand Down Expand Up @@ -115,7 +115,7 @@ Compiling under Mac OS X
------------------------
<div class="hline"></div>

>**TIP**: A ready made IQ-TREE package is provided by * [Homebrew](https://github.com/brewsci/homebrew-science/blob/master/Formula/iqtree.rb) by simply running `brew install homebrew/science/iqtree2`.
>**TIP**: A ready made IQ-TREE package is provided via the * [Homebrew tap brewsci/bio](https://github.com/brewsci/homebrew-bio/blob/master/Formula/iqtree2.rb). Simply run `brew install brewsci/bio/iqtree2` to install.
{: .tip}

* Make sure that Clang compiler is installed, which is typically the case if you installed Xcode and the associated command line tools.
Expand All @@ -126,16 +126,10 @@ Compiling under Mac OS X

The steps to compile IQ-TREE are similar to Linux (see above), except that you need to specify `clang` as compiler when configuring source code with CMake (step 4):

cmake -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ ..
cmake -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_CXX_FLAGS="-Dthread_local=" ..

(please change `cmake` to absolute path like `/Applications/CMake.app/Contents/bin/cmake`).

To compile the multicore version, the default installed Clang unfortunately does not support OpenMP (which might change in the near future). However, the latest Clang 3.7 supports OpenMP, which can be downloaded from <http://clang.llvm.org>. After that you can run CMake with:

cmake -DIQTREE_FLAGS=omp -DCMAKE_C_COMPILER=clang-3.7 -DCMAKE_CXX_COMPILER=clang++-3.7 ..

(assuming that `clang-3.7` and `clang++-3.7` points to the installed Clang 3.7).


Compiling under Windows
-----------------------
Expand Down