51 lines
1.5 KiB
Markdown
51 lines
1.5 KiB
Markdown
# Video-related files for NCMR songs
|
|
|
|
This repo houses the code-like files for NCMR music videos. Binary assets live elsewhere.
|
|
|
|
## Structure
|
|
|
|
### `master` branch — shared template
|
|
|
|
This branch holds the common scaffolding:
|
|
|
|
- **Remotion project** — entry point, root component, and a placeholder composition
|
|
- **`ffmpeg.sh`** — helper for baking ASS subtitles or bypassing with static image + audio
|
|
- **`src/lrc2srt.ts`** — legacy LRC → SRT subtitle converter
|
|
- **Build config** — TypeScript, ESLint, Prettier, Remotion studio
|
|
|
|
### Song branches
|
|
|
|
For each song, create a branch `<song-name>/master` (and optionally feature branches
|
|
like `<song-name>/synced-lyrics-remotion`):
|
|
|
|
```
|
|
git checkout -b <song-name>/master
|
|
```
|
|
|
|
Copy the shared template into the song branch, then add song-specific files:
|
|
|
|
```
|
|
mkdir -p <song-name>
|
|
# Place your song-specific compositions, assets manifests, etc.
|
|
```
|
|
|
|
The `master` branch remains protected and mostly immutable. Song branches are independent.
|
|
|
|
## Guideline
|
|
|
|
### Git-ignored (not tracked here)
|
|
|
|
- Binary input assets (audio, images, fonts, material video clips)
|
|
- Video output (`out/`, rendered files)
|
|
|
|
For untracked input assets, a **bill of materials** listing everything and explaining
|
|
what each file is will be mandatory. Keep it as `BOM.md` alongside your song assets.
|
|
|
|
### Branching
|
|
|
|
- `master` — minimal template, protected
|
|
- `<song>/master` — song-specific work
|
|
- `<song>/<feature>` — parallel features for a song
|
|
|
|
This repo's branching rules supersede any generic git operation conventions.
|