Repository navigation
Redesign the README: banner, player and stream cards, fixed clone URLs - #1
Merged
Merged
Conversation
- Add a banner, buttons, CI and stack badges, the player's tagline, the setup loop and section links - Add a three-phone card of the web player (ready, on air, off air), a library, Liquidsoap, Icecast, FFmpeg flow card and three stills of the X stream rendered with the streamer's own filter graph - Add a status table and a licensing table that matches ATTRIBUTION.md and scripts/fetch-cc-music.sh exactly - Fix the quickstart clone URL (it pointed at YOURNAME/lofi247) - Correct the visuals credit: the bundled starter loops are gradient clips from the docs/VISUALS.md recipe, not Seedance renders - Keep every setup step, warning, layout row, doc link and license note; the service diagram moves into a details block Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_01TZhsuWjATuivuiFYJGpbY5
- Both git clone lines used the YOURNAME placeholder, so the bootstrap and launch steps failed when pasted as written Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_01TZhsuWjATuivuiFYJGpbY5
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
The README was thorough but text and a mermaid diagram only. This rebuilds it in the same house style as the Operator Uplift website, the operatoruplift profile and the Allowance README, and fixes two things that were wrong:
data-init. The mermaid diagram is kept, in a collapsible section.ATTRIBUTION.mdandscripts/fetch-cc-music.shexactly: three CC0 starter tracks in the repo, then 13 fetched tracks, 7 CC0 and 6 CC BY 4.0 that require credit.main, and the manual Go Live and daily rotation steps on X.Fixes
docs/VPS-SETUP.mdusedhttps://github.com/YOURNAME/lofi247.git, which fails when pasted. They now useoperatoruplift/lofi247(the README adds "or your fork"). Separate commit.docs/VISUALS.mdrecipe "before any Seedance clips exist" (commits 1ae2a95 and e983342). The README now says that, and points to the Seedance workflow indocs/VISUALS.md.All images live in
docs/readme/(five PNGs and three JPEGs, about 1.2 MB).How the visuals were made
Docker has no daemon in this environment, so the stack itself could not boot. Everything shown is still real output from this repository's code:
build_filterswas extracted verbatim fromengine/streamer/entrypoint.shand run withrun_ffmpeg's encoder flags and the.env.exampledefaults, reading each starter loop and a starter track served over local HTTP, writing 20 seconds to an FLV file instead of X. Each render produced H.264 1280×720 at 30 fps with AAC 44.1 kHz stereo. The overlay font is Noto Sans JP from Google Fonts, the same Source Han design as the Noto Sans CJK face the streamer image installs.web/was served with the three endpoints nginx provides:/config.jsonas40-lofi-config.shwrites it from.env.example,/nowplaying.jsonin the exact shaperadio.liqwrites, and/radiostreaming a starter track in place of Icecast. Headless Chromium played it with no console errors or warnings. For the off-air screen,/radioreturned 503, as nginx would with Icecast down.Checks
bash -nonengine/streamer/entrypoint.sh,engine/nginx/40-lofi-config.shand all fivescripts/*.sh: pass.shellcheck -S error engine/streamer/entrypoint.sh scripts/*.sh(ShellCheck 0.11.0, the gate CI uses): pass. A full run reports one info-level note (SC1091 inscripts/vps-setup.sh, sourcing/etc/os-release).node --check web/player.js: pass.docker compose config -q, alone and withdocker-compose.ci.yml, using.env.example: pass.docker compose upand the CI stack-smoke job (no Docker daemon). The CI workflow's last five runs onmainall passed, the latest on 28 July 2026 for ed1c5f1.Worth a look
lofi247-gold.vercel.appfrom this environment. The repository has novercel.json, so that deployment has no/radio,/nowplaying.jsonor/config.json, and the player there can only show its "connecting" state. The README describes it as the repository homepage that Vercel publishes frommain, and says the station itself runs on your own server. If the homepage is meant to be a live demo, it needs a stream behind it.Suggested repository settings
lofi,radio,livestream,rtmp,liquidsoap,icecast,ffmpeg,docker-compose,self-hosteddocs/readme/banner.png(2400 × 1200) under Settings → General → Social preview.Generated by Claude Code