Skip to content

Getting Started

Set up a full development environment to build, customize, and debug kurikintons firmware.

Prerequisites

  • Git - Version control
  • Python 3.11+ - Build automation runtime
  • uv - Fast Python package installer
  • Task - Modern task runner
  • VS Code - Recommended editor

Install Tools

brew install git
brew install python@3.11
brew install uv
brew install go-task
brew install --cask visual-studio-code

winget install Git.Git
winget install Python.Python.3.11
winget install astral-sh.uv
winget install go-task.go-task
winget install Microsoft.VisualStudioCode

Setup Environment

Clone the repository and install all dependencies:

git clone https://gitlab.com/osechi/kurikintons.git
cd kurikintons
task env:setup

task env:setup will:

  • Create a Python virtual environment (.venv/)
  • Install all dependencies from pyproject.toml
  • Install build tools (PlatformIO, commitizen, mkdocs, etc.)
  • Set up pre-commit hooks for code quality

Verify

task --list

You should see available tasks: v2:build, v2:upload, monitor, etc.

Update Environment

To update to the latest version:

git pull origin main
task env:sync

Next Steps