Skip to main content

Quick Start

This guide currently uses Linux as the baseline environment. The workflow on other operating systems is generally similar. The source code is designed to be compatible, but non-Linux platforms have not yet been fully validated by the official team.

System Requirements​

  • Linux environment
  • GCC >= 10
  • CMake >= 3.31
  • git and make installed (or equivalent build tools)
  • Available kmdo/kmpkg toolchain (or initialize via kmpkgcore)

Installation Steps​

Path A: You already have kmdo/kmpkg installed​

If you already have a working kmdo/kmpkg toolchain and KMPKG_CMAKE is correctly configured, you can build directly:

# 1) Clone and build goose
git clone https://github.com/kumose/goose.git
cd goose
cmake --preset=default
cmake --build build -j"$(nproc)"
cmake --install build --prefix /your/install/path

Path B: Toolchain not installed (install kmpkgcore first)​

# 1) Prepare kmpkgcore
git clone https://github.com/kumose/kmpkgcore.git
cd kmpkgcore
./bootstrap-kmpkg.sh

export KMPKG_HOME=/home/jeff/kmpkgcore
export PATH=$PATH:$KMPKG_HOME
export KMPKG_CMAKE=$KMPKG_HOME/scripts/buildsystems/kmpkg.cmake

# 2) Clone and build goose
cd -
git clone https://github.com/kumose/goose.git
cd goose
cmake --preset=default
cmake --build build -j"$(nproc)"
cmake --install build --prefix /your/install/path

Getting Started Demo​

# 1) Verify installation output
ls /your/install/path

# 2) If there is a bin directory, add it to PATH
export PATH=$PATH:/your/install/path/bin

# 3) Go to your workspace and run installed artifacts
cd /path/to/your/workspace
# Run your goose executable or load your goose-related library here

Next Reading​