Skip to content

getting-started.md

Latest commit

 

History

History
88 lines (62 loc) · 1.64 KB

getting-started.md

File metadata and controls

88 lines (62 loc) · 1.64 KB
Raw
title Getting Started
parent Development
nav_order 1

Getting Started

This guide helps you build and run CrossInk locally.

Prerequisites

  • PlatformIO Core (pio) or VS Code + PlatformIO IDE
  • Python 3.8+
  • clang-format 21+ in your PATH (CI uses clang-format 21)
  • USB-C cable
  • Xteink X4 or X3 device for hardware testing

If ./bin/clang-format-fix fails with either of these errors, install clang-format 21:

  • clang-format: No such file or directory
  • .clang-format: error: unknown key 'AlignFunctionDeclarations'

Examples:

# Debian/Ubuntu (try this first)
sudo apt-get update && sudo apt-get install -y clang-format-21

# If the package is unavailable, add LLVM apt repo and retry
wget https://apt.llvm.org/llvm.sh
chmod +x llvm.sh
sudo ./llvm.sh 21
sudo apt-get update
sudo apt-get install -y clang-format-21

# macOS (Homebrew)
brew install clang-format

Then verify:

clang-format-21 --version

The reported major version must be 21 or newer.

Clone and initialize

git clone --recursive https://github.com/uxjulia/CrossInk
cd CrossInk

If you already cloned without submodules:

git submodule update --init --recursive

Build

pio run -e simulator
pio run -e default

pio run without an environment builds the X3/X4 and Sticky firmware targets listed in platformio.ini.

Flash

pio run -e default --target upload

Validation

./bin/clang-format-fix
pio check --fail-on-defect low --fail-on-defect medium --fail-on-defect high
pio run

What to read next