Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ Thanks for your interest in contributing to Hyperframes! This guide will help yo
3. Install dependencies: `bun install`
4. Create a branch: `git checkout -b my-feature`

The published skill source lives in `skills/`. To install skills while working in
this checkout, use `npx hyperframes skills update`, which installs globally. Run
project-local `npx skills add ...` from a separate video project: its destination
can overlap `skills/` and overwrite uncommitted changes. The repo-native skills in
`.claude/skills/` and `.agents/skills/` are already included in the checkout.

## Choosing work

Start with [available newcomer issues](https://github.com/heygen-com/hyperframes/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+no%3Aassignee) or [help-wanted issues](https://github.com/heygen-com/hyperframes/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+no%3Aassignee). Read the discussion and check existing PRs before starting; an unassigned issue may already have work in progress. Comment with your intended approach and coordinate a claim with a maintainer.
Expand Down
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,11 @@ npx skills add heygen-com/hyperframes
>
> `skills add` resolves the skills.sh registry blob, which can lag `main` by hours. `npx hyperframes skills update` installs from the current `main`, so reach for it when you need the newest copy of a skill.

Run project-local installs from your video project's directory. From a HyperFrames
checkout, use `npx hyperframes skills update` for a global install instead: a
project-local installer target can overlap the tracked `skills/` source and
overwrite uncommitted edits. See [contributor setup](CONTRIBUTING.md#getting-started).

Try a prompt like:

> Using `/hyperframes`, create a 10-second product intro with a fade-in title, a background video, and subtle background music.
Expand Down
6 changes: 6 additions & 0 deletions docs/guides/skills.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,12 @@ Run the interactive installer:
npx skills add heygen-com/hyperframes
```

Run this command from your video project's directory. If you cloned HyperFrames
to contribute, use `npx hyperframes skills update` for a global install from that
checkout, or run the project installer in a separate video project. Project-local
installer targets can overlap the checkout's tracked `skills/` source and
overwrite uncommitted edits.

Select **Core Skills**. That covers every kind of video; the other skills install when a request needs them, so you do not need the full catalog up front.

Start a fresh agent chat after installation, then ask it to use `/hyperframes`.
Expand Down
Loading