Skip to content

Latest commit

 

History

History
400 lines (320 loc) · 10.3 KB

BUILDING.md

File metadata and controls

400 lines (320 loc) · 10.3 KB
Raw

Building Instruments

Build Binary

Windows (MinGW llvm-mingw)

  1. Make sure you have Git for Windows installed.
  2. Make sure you have Perl, CMake (3.13 or later), Ninja, Golang and NASM installed and put them in PATH.
  • A recent version of Perl is required. On Windows, Active State Perl has been reported to work, as has MSYS Perl. Strawberry Perl also works but it adds GCC to PATH, which can confuse some build tools when identifying the compiler (removing C:\Strawberry\c\bin from PATH should resolve any problems).
  1. Open Git Bash from Start Menu and run
git clone https://github.com/Chilledheart/yass
cd yass
./scripts/build-mingw.sh
  1. Enjoy

Windows (MSVC)

  1. Make sure you have Git for Windows installed.
  2. Make sure you have Perl, CMake (3.13 or later), Ninja, Golang and NASM installed and put them in PATH.
  • A recent version of Perl is required. On Windows, Active State Perl has been reported to work, as has MSYS Perl. Strawberry Perl also works but it adds GCC to PATH, which can confuse some build tools when identifying the compiler (removing C:\Strawberry\c\bin from PATH should resolve any problems).
  1. Make sure you use Visual Studio 2019 (or 2022).
  • Make sure you have Visual Studio with C++ selected from download page.
  1. Make sure you have clang-cl in PATH:

  • Download and Run LLVM installer from GitHub Binary download page.

  • Choose Add LLVM to System Path.

Notes: please make sure you have LLVM (17.0 or above).

  1. Run x64 Native Tools Command Prompt for VS 2019 (or 2022) in Start Menu.

  2. Compile the program with Release configuration.

git clone https://github.com/Chilledheart/yass
cd yass
mkdir build
cd build
set CC=clang-cl
set CXX=clang-cl
cmake -G Ninja -DCMAKE_BUILD_TYPE=Release -DGUI=on ..
ninja yass

Windows (MinGW MSYS2)

  1. Install MSYS2 Package from official site.
  2. Run MSYS2 CLANG64 in Start Menu.
  3. Install required tools
pacman -S mingw-w64-clang-x86_64-clang \
          mingw-w64-clang-x86_64-gcc-compat \
          mingw-w64-clang-x86_64-perl \
          mingw-w64-clang-x86_64-go \
          mingw-w64-clang-x86_64-cmake \
          mingw-w64-clang-x86_64-ninja \
          mingw-w64-clang-x86_64-nasm \
          git

Notes: you might need to get GOROOT manually after install mingw-w64-clang-x86_64-go package by running:

export GOROOT=/clang64/lib/go
export GOPATH=/clang64
  1. Compiling the program.
git clone https://github.com/Chilledheart/yass
cd yass
mkdir build
cd build
cmake -G Ninja -DCMAKE_BUILD_TYPE=Release -DGUI=on ..
ninja yass
  1. Enjoy

macOS

  1. Make sure you have Xcode Command Line Tools installed (Xcode if possible):

Run in Terminal:

xcode-select --install
  1. Install the required build tools...

(for Homebrew users)

Run in Terminal:

brew install ninja cmake go p7zip

(for MacPorts users)

Run in Terminal:

sudo port install ninja cmake go p7zip

(for people who don't use MacPorts or Homebrew)

  1. CMake

Run in Terminal:

cd $TMPDIR
curl -L -O https://github.com/Kitware/CMake/releases/download/v3.25.1/cmake-3.25.1-macos10.10-universal.dmg
hdiutil attach cmake-3.25.1-macos10.10-universal.dmg
ditto /Volumes/cmake-3.25.1-macos10.10-universal/CMake.app /Applications/CMake.app
hdiutil detach /Volumes/cmake-3.25.1-macos10.10-universal
echo 'export PATH="/Applications/CMake.app/Contents/bin:${PATH}"' >> .zprofile
export PATH="/Applications/CMake.app/Contents/bin:${PATH}"
  1. Ninja

Run in Terminal:

cd $TMPDIR
curl -L -O https://github.com/ninja-build/ninja/releases/download/v1.11.1/ninja-mac.zip
unzip ninja-mac.zip
sudo install -m 755 ninja /usr/local/bin/ninja
  1. Golang

Run in Terminal:

cd $TMPDIR
# Change to https://go.dev/dl/go1.18.10.darwin-arm64.tar.gz if you are using Apple Silicon
curl -L -O https://go.dev/dl/go1.18.10.darwin-amd64.tar.gz
sudo tar -C /usr/local -xzf go1.18.10.darwin-amd64.tar.gz
echo 'export PATH="/usr/local/go/bin:${PATH}"' >> .zprofile
export PATH="/usr/local/go/bin:${PATH}"
  1. Compile the program with Release configuration.
git clone https://github.com/Chilledheart/yass
cd yass
mkdir build
cd build
cmake -G Ninja -DCMAKE_BUILD_TYPE=Release -DGUI=on ..
ninja yass

Debian/Ubuntu

  1. Install GNU C++ Compiler:
sudo apt-get install -y build-essential git
  1. Install required dependencies:
sudo apt-get install -y \
    cmake \
    ninja-build \
    pkg-config \
    perl \
    gettext \
    libgtk-3-dev

Notes: please make sure you have GCC (7.1 or above) or Clang (17.0 or above) and CMake (3.13 or above).

For GCC, cmake argument -DUSE_LIBCXX=off should be passed to disable libc++ build under gcc.

You might want to give these APT/PPA sites a look if the requirements are not meet:

  1. Install Golang manually:
cd /tmp
wget https://go.dev/dl/go1.18.10.linux-amd64.tar.gz
sudo tar -C /usr/local -xzf go1.18.10.linux-amd64.tar.gz
echo 'export PATH="/usr/local/go/bin:${PATH}"' >> ~/.bashrc
export PATH="/usr/local/go/bin:${PATH}"
  1. Compile the program with Release configuration.
git clone https://github.com/Chilledheart/yass
cd yass
mkdir build
cd build
cmake -G Ninja -DCMAKE_BUILD_TYPE=Release -DGUI=on ..
ninja yass

Fedora/RHEL/CentOS/AlmaLinux/Rocky Linux

  1. Install GNU C++ Compiler:
sudo yum install -y gcc gcc-c++ \
    make python bash coreutils diffutils patch git
  1. Install required dependencies:
sudo yum install -y \
    cmake \
    ninja-build \
    pkg-config \
    perl \
    gtk3-devel \
    gettext \
    golang

Notes: please make sure you have GCC (7.1 or above) or Clang (17.0 or above) and CMake (3.13 or above).

For GCC, cmake argument -DUSE_LIBCXX=off should be passed to disable libc++ build under gcc.

You might want to enable CodeReady (for RHEL), PowerTools (for CentOS) and EPEL repo before above commands:

  • CodeReady (for RHEL 7):
subscription-manager repos --enable rhel-*-optional-rpms \
                           --enable rhel-*-extras-rpms \
                           --enable rhel-ha-for-rhel-*-server-rpms

  • CodeReady (for RHEL 8): subscription-manager repos --enable codeready-builder-for-rhel-8-x86_64-rpms

  • PowerTools (for CentOS 8): yum-config-manager --enable powertools

  • EPEL 8: yum install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm

  • CodeReady (for RHEL 9): subscription-manager repos --enable codeready-builder-for-rhel-9-x86_64-rpms

  • CRB (for CentOS 9): yum-config-manager --enable crb

  • EPEL 9: yum install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-9.noarch.rpm

  1. Compile the program with Release configuration.
git clone https://github.com/Chilledheart/yass
cd yass
mkdir build
cd build
cmake -G Ninja -DCMAKE_BUILD_TYPE=Release -DGUI=on ..
ninja yass

FreeBSD

  1. Install Clang Compiler (Optional):

It is impossible to upgrade system compiler without upgrading OS, so you can install latest Clang:

pkg install llvm17-lite

Notes: please make sure you have Clang (17.0 or above) and CMake (3.13 or above).

  1. Install required dependencies:
pkg install -y \
    git \
    cmake \
    ninja \
    pkgconf \
    perl5 \
    gettext \
    gtk3 \
    go

Notes: please install src.txz package of system otherwise you might need to create symbolics of unwind.h like below:

ln -sf /usr/include/c++/v1/unwind.h /usr/include/unwind.h
ln -sf /usr/include/c++/v1/unwind-arm.h /usr/include/unwind-arm.h
ln -sf /usr/include/c++/v1/unwind-itanium.h /usr/include/unwind-itanium.h

Notes: Not required since FreeBSD 13.1

  1. Compile the program with Release configuration.
git clone https://github.com/Chilledheart/yass
cd yass
export PATH="/usr/local/llvm17/bin:$PATH"
export CC=clang
export CXX=clang++
mkdir build
cd build
cmake -G Ninja -DCMAKE_BUILD_TYPE=Release -DGUI=on ..
ninja yass

Build Packaging

MinGW/Packaging

Make sure you have Golang installed on your system.

Run in Git Bash in Start Menu:

./scripts/build-mingw.sh

macOS/Packaging

Make sure you have Golang installed on your system.

Run in Terminal:

cd tools
go build
cd ..
./tools/build

Debian/Packaging

  1. Install Packaging Tools
sudo apt-get install -y git build-essential fakeroot devscripts debhelper

  1. Install Clang and put its binaries in PATH

  2. Generate Packages under parent directory

export CC=clang
export CXX=clang++
./scripts/build-deb.sh

Fedora/RHEL/CentOS/AlmaLinux/Rocky Linux Packaging

  1. Install Packaging Tools
sudo yum install -y gcc gcc-c++ \
    rpm-build rpm-devel rpmlint make python bash coreutils diffutils patch rpmdevtools

  1. Install Clang and put its binaries in PATH

  2. Generate Packages under current directory

export CC=clang
export CXX=clang++
./scripts/build-rpm.sh

FreeBSD/Packaging

Make sure you have Golang installed on your system.

Run in Terminal:

cd tools
go build
cd ..
./tools/build

Android/Packaging

See android's README.md

HarmonyOS/Packaging

See harmonyOS's README.md

iOS/Packaging

Make sure you have Xcode installed on your system.

TBD