Skip to content

Shorten the README - #172

Merged
kriboe90 merged 1 commit into
masterfrom
claude/readme-consolidation-b2270f
Oct 29, 2026
Merged

kriboe90 merged 1 commit into
masterfrom
claude/readme-consolidation-b2270f

Conversation

@kriboe90

Copy link
Copy Markdown
Contributor

What changed

The README goes from 386 to 224 lines.

  • Removed the Corrupted images and Vertical images sections.
  • Background correction: kept the table of reference_property options and one sentence on sideband_distances and sideband_exclusion_margin.
  • Temperature correction: cut down to the config section, the two file layouts (with one example), the time reference, and how values outside the table are handled.
  • Condensed Analysed quantities and result files (the directory tree is now a single path pattern), Reference images, Stacked multi-camera analysis and Contributing.
  • The workflow intro said "three main steps" but listed five, so the count is gone.

Why

The README had grown into a detailed manual. The details are better kept in the documentation.

Notes for reviewers

The old background correction section said background_floor defaults to 5 %. Since #170 it defaults to no lower limit, so that sentence was dropped rather than shortened.

🤖 Generated with Claude Code

Remove the corrupted images and vertical images sections, shorten the
background and temperature correction sections and condense the result
files, reference images, stacked analysis and contributing sections.
Drop the outdated background_floor default of 5 %.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@kriboe90
kriboe90 merged commit 9532d6f into master Oct 29, 2026
3 checks passed
@kriboe90
kriboe90 deleted the claude/readme-consolidation-b2270f branch October 29, 2026 10:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant