Skip to content

Docs: rewrite the README - #395

Merged
ItsAlphaNeon merged 2 commits into
mainfrom
readme-rewrite
Nov 9, 2026
Merged

ItsAlphaNeon merged 2 commits into
mainfrom
readme-rewrite

Conversation

@ItsAlphaNeon

@ItsAlphaNeon ItsAlphaNeon commented Nov 9, 2026 •

Copy link
Copy Markdown
Owner

What changed

The old README had grown to 500 lines and was out of date. It's now 227 lines, stays surface level, and sends readers to the website and wiki for detail.

Section What's there
What is Lemon Studio? A short description and the pre-alpha warning
Features The main workspaces and tools, the 29 built-in plugins, and .lemon and .flp project files
Status One row per area, with what's still missing
Get Lemon Studio System requirements, the download page, and three commands to build from source
Plans Steps to the first alpha, and what comes after it
Community, license, trademarks Discord, bug reports, the clean-room rule, the ArtCraft request, and the notices

Other changes

  • Names: the README now says arranger and instrument rack, as the app does. FL Studio appears only in the .flp section and the trademark notice.
  • Screenshots: they're now the website's pictures of the demo song. The old ones were an empty project still labelled Playlist and Channel rack.
  • docs/development.md (new): tests, crates, command-line tools, plugin folders, environment variables and the full third-party table moved here, so nothing is lost. A row for os-smf is new, and the per-plugin crate rows are now one paragraph.
  • docs/status.md: its links to removed README sections now point to the Status section and the wiki's Troubleshooting page. Its body still uses the old names.

Worth checking

  • Scripting and AI assistants: these now appear only in docs/development.md, in line with keeping them off the website. The old README listed them openly.
  • Going stale: the "No builds have been released yet" line and the first-alpha table need updating when the first nightly ships.

Testing

  • All relative links and files resolve, and every external link in the README answered 200.
  • Emojis appear only in the status columns and their legends.
  • Not yet looked at as rendered on GitHub, which this draft makes possible.

🤖 Generated with Claude Code

ItsAlphaNeon and others added 2 commits November 8, 2026 17:58
The old README had grown to 500 lines and was out of date. The new one stays
surface level and sends readers to the website and wiki for detail: what
Lemon Studio is, its features and built-in plugins, a short status table,
how to get it, and the plans for the first alpha and after.

It uses the names the app shows (arranger, instrument rack), and its
screenshots are the website's, of the demo song, in place of an empty project
with the old labels.

The details that don't belong there move to docs/development.md: tests, the
crates, command-line tools, plugin folders, environment variables and the
full third-party table. docs/status.md's links follow.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Each one that merges or closes would need a README edit.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ItsAlphaNeon
ItsAlphaNeon marked this pull request as ready for review November 9, 2026 01:03
@ItsAlphaNeon
ItsAlphaNeon merged commit d9e97a2 into main Nov 9, 2026
3 checks passed
@ItsAlphaNeon
ItsAlphaNeon deleted the readme-rewrite branch November 9, 2026 01:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant