Skip to content

Add git-lfs as a prerequisite in README - #14

Open
kraenhansen wants to merge 2 commits into
ProtonMail:release/2.30.0-335from
kraenhansen:readme-git-lfs-prerequisite
Open

Add git-lfs as a prerequisite in README#14
kraenhansen wants to merge 2 commits into
ProtonMail:release/2.30.0-335from
kraenhansen:readme-git-lfs-prerequisite

Conversation

@kraenhansen

Copy link
Copy Markdown

Summary

  • Adds a Prerequisites section to the README noting that Git LFS must be installed before cloning or building
  • Without git-lfs, ./gradlew testDebugUnitTest testDevDebugUnitTest (documented in the Testing section) fails with a FilterFailedException because Gradle's embedded jgit tries to smudge LFS-tracked snapshot test images and can't find the git-lfs command

Test plan

  • Verified that the test command fails without git-lfs installed (git-lfs: command not found, return code 127)
  • Confirmed the README renders correctly with the new section

🤖 Generated with Claude Code

kraenhansen and others added 2 commits April 11, 2026 10:13
The Gradle build fails with a FilterFailedException if git-lfs is not
installed, because jgit tries to smudge LFS-tracked snapshot test images
and shells out to git-lfs which isn't found. This adds a prerequisites
section to make that dependency explicit.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The git-lfs website already covers installation for all platforms.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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