Tutorial
========

This tutorial walks you through building a ForkBit plugin from scratch.
By the end, you'll have a working plugin with a custom UI, persistent data,
settings, git integration, and translations.

Prerequisites
-------------

- Python 3.13+
- ForkBit installed on your machine
- Basic familiarity with PySide6 (Qt for Python)

Install the SDK:

.. code-block:: bash

   pip install forkbit-sdk

Verify the installation:

.. code-block:: bash

   forkbit --version

What you'll build
-----------------

A **Release Notes** plugin that:

1. Shows a text editor for writing release notes
2. Saves notes to disk per version
3. Lets the user configure a default template via settings
4. Creates a git tag when the user publishes
5. Translates notes to other languages

Each chapter builds on the previous one. Start with :doc:`scaffold`.