docs(readme): personal-fork README + drop README from version tooling - #7
Merged
Conversation
Replace the upstream README with a personal-fork README: explain this is an edited version of Marinara Engine maintained by former dev LukaTheHero for personal use (anyone is free to use it), note that I update it with my own preferences, and list the fork-specific changes (Claude Subscription model list + Fable 5, [1m] 1M-context handling, multi-open persistent group folders, right-click Quick Start menu). Keep only the License section from the original. Also drop README.md from the version-sync tooling (scripts/versioning.mjs) and its now-unused updateReadme/format/release-line helpers, so `pnpm version:check` and `version:sync` no longer expect a "Current stable release" line the personal README intentionally omits. README.md was not in CLAUDE.md's derived-version-file list anyway.
✅ Bunny Review CompletedTip Review posted. The specimen has left the observation table.
|
🐰 Bunny ReviewBunny Merge Signal: ReadyTip READY
Note Mode: 🧭 Specimen Summary
🔎 Isolated DefectsTip No actionable defects isolated. 🧹 Nitpicks
✅ Control Checks
🧪 Observations
🧰 CI Status
|
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.
Why
This is my personal fork of Marinara Engine, not the upstream project. The README should make that clear and document what's different in my version, instead of duplicating upstream's install/feature docs.
What
README.mdas a personal-fork README: states it's an edited version of Marinara Engine maintained by former dev LukaTheHero for personal use (anyone is free to use it), notes that I update it with my own preferences, and lists the fork-specific changes:[1m]1M-context support for Claude (Subscription)README.mdfrom the version-sync tooling (scripts/versioning.mjs), along with the now-unusedupdateReadme/format/ release-line helpers, sopnpm version:checkandversion:syncno longer expect a "Current stable release" line the personal README intentionally omits. (README.mdwasn't in CLAUDE.md's derived-version-file list anyway.)pnpm version:checkpasses andpnpm lintis clean.