INSTALL.txt

This software requires c++11 to build,
which is available in GCC >= 4.8 (on linux) and Clang >= 3.3 (on mac)

Dependencies:
-------------
   - CMake 3.2 or above ( https://cmake.org/ )
   - either...
       GNU Scientific Library ( http://www.gnu.org/software/gsl/ )
     or..
       Boost Library ( http://www.boost.org ) (see "-DBOOST_ROOT" below)
   - Zlib ( included with OS X and most Linuxes, http://www.zlib.net ) *
   - C++ compiler with C++11 and openmp support
       Note for macOS users: Use "libomp" to link openmp with Clang
       libomp is available through brew ( https://formulae.brew.sh/formula/libomp )


Steps:
------
   mkdir build 
   cd build
   cmake .. -DCMAKE_BUILD_TYPE=Release [--install-prefix ...  -DGSL_SHARED=... -DGSL_ROOT_DIR=... -DBOOST_ROOT=...]
   cmake --build .


Products:
---------
   - Executable fastANI built in the build directory


cmake configure options:
-----------------------------
--install-prefix </path/to/install>
  Installs binaries to bin/ and libraries to lib/ within this path. The default
  is /usr/local/, which will typically require sudo for make install. Must be
  absolute path.
  lib/.
-DGSL_ROOT_DIR=</path/to/gsl_dir>
  Where to find the GNU Scientific library install if not in the default
  location (/usr/local). Must be absolute path and should not include bin/ or
-DGSL_SHARED=OFF
  Statically link the GNU Scientific library instead of dynamically. Be mindful
  of licensure if distributing.
-DBOOST_ROOT=</path/to/boost/>
  Use Boost from this location, instead of GSL. Must be absolute path and should
  not include bin/ or lib/. Will be statically linked. Be mindful of licensure
  if distributing.