Skip to content

docs(readme): note git-lfs requirement for full clones #423

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jrusso1020 merged 3 commits into from
Apr 22, 2026
+26 −3
Merged

docs(readme): note git-lfs requirement for full clones #423

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
996ebff
docs(readme): note git-lfs requirement for full clones
jrusso1020 Apr 22, 2026
5519f0b
docs(readme): add Windows install instructions for git-lfs
jrusso1020 Apr 22, 2026
11aa4d3
chore(ci): fix oxfmt formatting on renovate.json
jrusso1020 Apr 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions .github/renovate.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,7 @@
},
{
"enabled": false,
"matchPackageNames": [
"/^@hyperframes//"
]
"matchPackageNames": ["/^@hyperframes//"]
}
]
}
25 changes: 25 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,31 @@ npx skills add heygen-com/hyperframes

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

### Cloning the repo

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:

```bash
# macOS
Comment thread
miguel-heygen marked this conversation as resolved.
brew install git-lfs

# Ubuntu/Debian
sudo apt install git-lfs

# Windows
winget install GitHub.GitLFS
# (or install Git for Windows, which bundles Git LFS as an optional component)

# Then (once, per machine)
git lfs install
```

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:

```bash
GIT_LFS_SKIP_SMUDGE=1 git clone https://github.com/heygen-com/hyperframes.git
```

## License

[Apache 2.0](LICENSE)
Loading