Skip to content

Commit 6accf09

Browse files
authored
docs(readme): note git-lfs requirement for full clones (heygen-com#423)
* docs(readme): note git-lfs requirement for full clones Repo uses Git LFS for regression-test baselines (~240 MB of .mp4 files under packages/producer/tests/**/output.mp4). Users cloning without git-lfs installed hit a cryptic 'git-lfs: command not found' error, as reported in heygen-com#407. Document the requirement with install instructions and the GIT_LFS_SKIP_SMUDGE=1 escape hatch. * docs(readme): add Windows install instructions for git-lfs Per review from @miguel-heygen. * chore(ci): fix oxfmt formatting on renovate.json Drive-by to unblock CI. Landed unformatted in heygen-com#422 because Renovate's config-migration PR bypasses the lefthook pre-commit hook, so every subsequent PR's `bun run format:check` (which scans the whole repo) was failing on this file.
1 parent 5be207f commit 6accf09

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,31 @@ npx skills add heygen-com/hyperframes
191191

192192
See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
193193

194+
### Cloning the repo
195+
196+
The repo uses [Git LFS](https://git-lfs.com) for golden regression-test baselines under `packages/producer/tests/**/output.mp4` (~240 MB of `.mp4` files). If you're cloning the full repo for development, install Git LFS first:
197+
198+
```bash
199+
# macOS
200+
brew install git-lfs
201+
202+
# Ubuntu/Debian
203+
sudo apt install git-lfs
204+
205+
# Windows
206+
winget install GitHub.GitLFS
207+
# (or install Git for Windows, which bundles Git LFS as an optional component)
208+
209+
# Then (once, per machine)
210+
git lfs install
211+
```
212+
213+
If you hit `git-lfs filter-process: command not found` during `git clone` or `npx skills add heygen-com/hyperframes`, install Git LFS and retry. You can also skip LFS content if you only need the source files:
214+
215+
```bash
216+
GIT_LFS_SKIP_SMUDGE=1 git clone https://github.com/heygen-com/hyperframes.git
217+
```
218+
194219
## License
195220

196221
[Apache 2.0](LICENSE)

0 commit comments

Comments
 (0)