Getting Started

Use this path if you are starting from zero and want a practical first result.

1. Install the package

Install with your package manager:

npm install timetable-sa

pnpm add timetable-sa

yarn add timetable-sa

bun add timetable-sa

Then read the full install notes in Installation.

2. Run the first solver flow

Follow Quick Start to define:

• your state model,
• hard and soft constraints,
• move generators,
• solver configuration.

3. Understand the core contracts

Before scaling to real workloads, read Core Concepts to understand constraint scoring, move lifecycle, and phase behavior.

4. Tune for production workloads

When basic integration works, continue with:

• Configuration for runtime tuning,
• Advanced Features for tabu, aspiration, and reheating,
• Testing Guide for reliability and regression safety.