dan/ScanSlicer
dan/ScanSlicer
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions
Fork of ScanSlicer (https://github.com/macrodev8/ScanSlicer), implementing a mirrored export patch.
78 commits 1 branch 1 tag 210 KiB
Find a file
dev 0b26c66021 docs: add documentation index
2026-02-27 11:53:42 +00:00
docs docs: add documentation index 2026-02-27 11:53:42 +00:00
scanslicer refactor(ui_builders_shared): add module tail helpers and finalize layout 2026-02-26 12:25:34 +00:00
.dockerignore chore: add repository ignore and container ignore rules 2026-02-18 10:15:00 +00:00
.env.example chore: add example environment variables for desktop runtime 2026-02-18 10:31:31 +00:00
.gitignore chore: add repository ignore and container ignore rules 2026-02-18 10:15:00 +00:00
pyproject.toml build: add pyproject metadata for setuptools packaging 2026-02-18 10:35:00 +00:00
setup.py build: add legacy setuptools shim entry point 2026-02-18 11:10:54 +00:00
uv.lock build: add uv lockfile for reproducible dependency resolution 2026-02-26 15:54:55 +00:00

docs/README.md

ScanSlicer Docs

This folder contains in-depth documentation for ScanSlicer.

Contents

  • docs/user-guide.md: How to use the application end-to-end.
  • docs/architecture.md: Module layout, responsibilities, and runtime flow.
  • docs/parameters.md: Detection parameter catalog (defaults, ranges, and effects).
  • docs/autotune.md: Auto-tune profiles, candidate search, scoring, and feedback learning.
  • docs/runtime-config.md: Backend selection, environment variables, and persistence paths.
  • docs/appimage.md: Local and Docker AppImage build workflows.
  • docs/development.md: Developer-oriented codebase and workflow notes.

Recommended Reading Order

  1. README.md (project overview and quick start)
  2. docs/user-guide.md
  3. docs/parameters.md
  4. docs/autotune.md
  5. docs/architecture.md
  6. docs/runtime-config.md
  7. docs/appimage.md
  8. docs/development.md