Master Build Status

Development Build Status

Installing

We offer binary images of the latest releases here: http://latest.turtlecoin.lol

If you would like to compile yourself, read on.

How To Compile

Linux

Prerequisites

You will need the following packages: Boost, OpenSSL, cmake (3.8 or higher), make, and git.

You will also need either GCC/G++, or Clang.

If you are using GCC, you will need GCC-7.0 or higher.

If you are using Clang, you will need Clang 6.0 or higher. You will also need libstdc++-6.0 or higher.

Ubuntu, using GCC

• sudo add-apt-repository ppa:ubuntu-toolchain-r/test -y
• sudo apt-get update
• sudo apt-get install aptitude -y
• sudo aptitude install -y build-essential g++-8 gcc-8 git libboost-all-dev python-pip libssl-dev
• sudo pip install cmake
• export CC=gcc-8
• export CXX=g++-8
• git clone -b master --single-branch https://github.com/turtlecoin/turtlecoin
• cd turtlecoin
• mkdir build
• cd build
• cmake ..
• make

The binaries will be in the src folder when you are complete.

• cd src
• ./TurtleCoind --version

Ubuntu, using Clang

• sudo add-apt-repository ppa:ubuntu-toolchain-r/test -y
• wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -

You need to modify the below command for your version of ubuntu - see https://apt.llvm.org/

• Ubuntu 14.04 (Trusty)

• sudo add-apt-repository "deb https://apt.llvm.org/trusty/ llvm-toolchain-trusty 6.0 main"

• Ubuntu 16.04 (Xenial)

• sudo add-apt-repository "deb https://apt.llvm.org/xenial/ llvm-toolchain-xenial 6.0 main"

• Ubuntu 18.04 (Bionic)

• sudo add-apt-repository "deb https://apt.llvm.org/bionic/ llvm-toolchain-bionic 6.0 main"

• sudo apt-get update

• sudo apt-get install aptitude -y

• sudo aptitude install -y -o Aptitude::ProblemResolver::SolutionCost='100*canceled-actions,200*removals' build-essential clang-6.0 libstdc++-7-dev git libboost-all-dev python-pip libssl-dev

• sudo pip install cmake

• export CC=clang-6.0

• export CXX=clang++-6.0

• git clone -b master --single-branch https://github.com/turtlecoin/turtlecoin

• cd turtlecoin

• mkdir build

• cd build

• cmake ..

• make

The binaries will be in the src folder when you are complete.

• cd src
• ./TurtleCoind --version

Generic Linux

Ensure you have the dependencies listed above.

If you want to use clang, ensure you set the environment variables CC and CXX. See the ubuntu instructions for an example.

• git clone -b master --single-branch https://github.com/turtlecoin/turtlecoin
• cd turtlecoin
• mkdir build
• cd build
• cmake ..
• make

The binaries will be in the src folder when you are complete.

• cd src
• ./TurtleCoind --version

OSX/Apple, using GCC

Prerequisites

• Install XCode and Developer Tools.

Building

• which brew || /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
• brew install --force cmake boost llvm gcc@8 openssl
• export CC=gcc-8
• export CXX=g++-8
• git clone -b master --single-branch https://github.com/turtlecoin/turtlecoin
• cd turtlecoin
• mkdir build
• cd build
• cmake ..
• make

The binaries will be in the src folder when you are complete.

• cd src
• ./TurtleCoind --version

OSX/Apple, using Clang

Prerequisites

• Install XCode and Developer Tools.

Building

• which brew || /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
• brew install --force cmake boost llvm openssl
• export CC=/usr/local/opt/llvm/bin/clang
• export CXX=/usr/local/opt/llvm/bin/clang++
• git clone -b master --single-branch https://github.com/turtlecoin/turtlecoin
• cd turtlecoin
• mkdir build
• cd build
• cmake ..
• make

The binaries will be in the src folder when you are complete.

• cd src
• ./TurtleCoind --version

Windows

Prerequisites

You can build for 32-bit or 64-bit Windows. If you're not sure, pick 64-bit.

• Install Visual Studio 2017 Community Edition
• When installing Visual Studio, it is required that you install Desktop development with C++
• Install the latest version of Boost (currently Boost 1.68). Select the appropriate version for your system:
  • Boost 64-bit
  • Boost 32-bit
• Install the latest full version of OpenSSL (currently OpenSSL 1.1.1b). Select the appropriate version for your system:
  • OpenSSL 64-bit
  • OpenSSL 32-bit

Building

For 64-bit:

• From the start menu, open 'x64 Native Tools Command Prompt for vs2017'.
• cd <your_turtlecoin_directory>
• mkdir build
• cd build
• set PATH="C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\IDE\CommonExtensions\Microsoft\CMake\CMake\bin";%PATH%
• cmake -G "Visual Studio 15 2017 Win64" .. -DBOOST_ROOT=C:/local/boost_1_68_0
• MSBuild TurtleCoin.sln /p:Configuration=Release /m

For 32-bit:

• From the start menu, open 'x86 Native Tools Command Prompt for vs2017'.
• cd <your_turtlecoin_directory>
• mkdir build
• cd build
• set PATH="C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\IDE\CommonExtensions\Microsoft\CMake\CMake\bin";%PATH%
• cmake -G "Visual Studio 15 2017" .. -DBOOST_ROOT=C:/local/boost_1_68_0
• MSBuild TurtleCoin.sln /p:Configuration=Release /p:Platform=Win32 /m

The binaries will be in the src/Release folder when you are complete.

• cd src
• cd Release
• TurtleCoind.exe --version

Run Automated Tests

Unit tests are implemented using Googletest. A separate test build configured for make creates an executable test runner.
After following the build steps above:

• cd <turtlecoin_directory>
• cd build
• cmake ..
• make turtlecoin_test

The test binary will be in the src/test directory when building completes. Run the file to run the tests and view the test report:

• ./test/turtlecoin_test

Thanks

Cryptonote Developers, Bytecoin Developers, Monero Developers, Forknote Project, TurtleCoin Community

Copypasta for license when editing files

Hi TurtleCoin contributor, thanks for forking and sending back Pull Requests. Extensive docs about contributing are in the works or elsewhere. For now this is the bit we need to get into all the files we touch. Please add it to the top of the files, see src/CryptoNoteConfig.h for an example.

// Copyright (c) 2012-2017, The CryptoNote developers, The Bytecoin developers
// Copyright (c) 2014-2018, The Monero Project
// Copyright (c) 2018-2019, The TurtleCoin Developers
//
// Please see the included LICENSE file for more information.