dan/ScanSlicer
dan/ScanSlicer
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

docs: clarify runtime config paths for host and Docker usage

Browse source
This commit is contained in:
dev 2026-03-04 14:26:14 +00:00
parent 44d7cae2bf
commit 331e65d948
2 changed files with 9 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

1
.gitignore vendored
View file

@ -9,4 +9,3 @@
/build/ /build/
/appimage/ /appimage/
.env .env
/.scanslicer/

11
README.md
View file

@ -30,7 +30,7 @@ Project dependencies (from `pyproject.toml`):
## Quick Start ## Quick Start
### Run with `uv` (recommended for local dev) ### Run with `uv`
```bash ```bash
uv sync --frozen uv sync --frozen
@ -87,16 +87,21 @@ Only locked boxes are exported.
## Data and Config Files ## Data and Config Files
Default host paths: Persistence paths depend on how ScanSlicer is run.
Non-container runs (`uv run scanslicer`, `python -m scanslicer`):
- Defaults: `~/.config/scanslicer/defaults.json` - Defaults: `~/.config/scanslicer/defaults.json`
- Named presets: `~/.config/scanslicer/presets.json` - Named presets: `~/.config/scanslicer/presets.json`
- Auto-tune feedback: `~/.config/scanslicer/autotune-feedback.json` - Auto-tune feedback: `~/.config/scanslicer/autotune-feedback.json`
- Session status log: `~/.config/scanslicer/status.log` - Session status log: `~/.config/scanslicer/status.log`
Container behavior: If `XDG_CONFIG_HOME` is set, these are stored under `$XDG_CONFIG_HOME/scanslicer/` instead.
Container runs:
- When running in container and `/work` exists, these are stored under `/work/.scanslicer/`. - When running in container and `/work` exists, these are stored under `/work/.scanslicer/`.
- In the provided `docker-compose.yml`, the current repository is mounted as `/work`, so these files appear in `.scanslicer/` inside the project directory on the host.
Environment variable overrides: Environment variable overrides: