Master Build Status

Development Build Status

Installing

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

If you would like to compile yourself, read on.

How To Compile

Linux

Prerequisites

You will need the following packages: boost, 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-6.0 or higher.

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

GCC setup, on Ubuntu

• 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
• 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

Clang setup, on Ubuntu

• 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

• 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

Apple

Prerequisites

• Install cmake. See here if you are unable to call cmake from the terminal after installing.
• Install the boost libraries. Either compile boost manually or run brew install boost.
• Install XCode and Developer Tools.

Building

• git clone -b master --single-branch https://github.com/turtlecoin/turtlecoin
• cd turtlecoin
• mkdir build && cd $_
• cmake .. or cmake -DBOOST_ROOT=<path_to_boost_install> .. when building from a specific boost install. If you used brew to install boost, your path is most likely /usr/local/include/boost.
• make

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

• cd src
• ./TurtleCoind --version

If your version of gcc is too old, you may need to run:

• brew install gcc@8
• export CC=gcc-8
• export CXX=g++-8

Windows

Prerequisites

• 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.

Building

• 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 (Or your boost installed dir.)
• MSBuild TurtleCoin.sln /p:Configuration=Release /m

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

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

Raspberry Pi 3 B+

The following images are known to work. Your operation system image MUST be 64 bit.

Known working images

• https://github.com/Crazyhead90/pi64/releases
• https://fedoraproject.org/wiki/Architectures/ARM/Raspberry_Pi#aarch64_supported_images_for_Raspberry_Pi_3
• https://archlinuxarm.org/platforms/armv8/broadcom/raspberry-pi-3

Once you have a 64 bit image installed, setup proceeds the same as any Linux distribution. Ensure you have at least 2GB of ram, or the build is likely to fail. You may need to setup swap space.

Building

• 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

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, The TurtleCoin Developers
// 
// Please see the included LICENSE file for more information.