Repository navigation
Docs: rewrite the README - #395
Merged
Merged
Conversation
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>
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 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.
.lemonand.flpproject filesOther changes
.flpsection and the trademark notice.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 foros-smfis 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
docs/development.md, in line with keeping them off the website. The old README listed them openly.Testing
🤖 Generated with Claude Code