diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 21 |
1 files changed, 17 insertions, 4 deletions
@@ -30,10 +30,11 @@ The server currently exposes tools for: - RPM spec metadata summaries - QML translation search and Sailfish ternary translation checks -The committed defaults are deliberately generic. Device tools default to the -placeholder SSH target `root@device`, the Sailfish user-session bus at -`/run/user/100000/dbus/user_bus_socket`, `~/git` as the local source root, -`~/OBS` as the OBS checkout root, and the vendored build helper at +The committed configuration template defaults are deliberately generic. +Device tools default to the placeholder SSH target `root@device`, the Sailfish +user-session bus at `/run/user/100000/dbus/user_bus_socket`, `~/git` as the +local source root, `~/OBS` as the OBS checkout root, and the vendored build +helper at `src/sailfish_devel_mcp/vendor/build_sailfishos.py`. Put a config file at `~/.config/sailfish-devel-mcp/config.json` or pass `--config` to provide your real device and OBS settings. Device entries can also carry the preferred user, @@ -44,6 +45,18 @@ back to a matching tag in the third-party coderus Docker mirror. Neither a configured device label nor mirror tag availability independently establishes the current official SailfishOS release or SDK target. +The Python configuration module is machine-local and intentionally ignored by +Git. Bootstrap a fresh checkout before running, testing, installing, or +packaging it: + +```sh +cp src/sailfish_devel_mcp/config.py.template src/sailfish_devel_mcp/config.py +``` + +Keep machine-specific Python defaults only in the ignored `config.py`. Prefer +the JSON configuration described below for ordinary device, SDK, and build-host +settings. + ## Running From a checkout: |