From 114457348139f4f3039b2812eb995fbac3c26489 Mon Sep 17 00:00:00 2001 From: Bart Schuijt Date: Wed, 24 Jun 2026 10:38:03 +0200 Subject: [PATCH] Clarify that fitness settings live in fitness_functions.yaml. Quick start previously implied config.py holds configuration; make clear that YAML is the editable FF config and project config.py is optional SQLMesh loader wiring for native sqlmesh commands. Co-authored-by: Cursor --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dda5070..3691810 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,10 @@ uv add ../sqlmesh-ff ## Quick start -1. Add `fitness_functions.yaml` to your SQLMesh project root (see [Configuration](#configuration)). -2. Add a small `config.py` bootstrap (see [Where configuration lives](#where-configuration-lives)) — SQLMesh requires the loader as a Python class and cannot load `config.py` and `config.yaml` in the same folder. +Your fitness function settings live in **`fitness_functions.yaml`** — that is the config you edit. The project `config.py` is optional SQLMesh wiring only (see below). + +1. Add `fitness_functions.yaml` to your SQLMesh project root with your thresholds and rule toggles (see [Configuration](#configuration)). +2. **Optional — only for native SQLMesh commands** (`sqlmesh plan`, etc.): add a small `config.py` bootstrap that registers `FitnessLoader` and points at `fitness_functions.yaml` (see [Where configuration lives](#where-configuration-lives)). SQLMesh requires the loader as a Python class and cannot load `config.py` and `config.yaml` in the same folder. You do **not** put fitness settings in `config.py`. 3. Run lint: ```bash