Add README.md + MIT LICENSE - #40
Merged
Merged
Conversation
Public-facing README written in the project's bilingual Chinese-tech
voice (matches the user's working language). Structure:
1. Logo + tagline + platform badges
2. One-table install per OS (with the xattr workaround called out)
3. "What is petpet?" β zero-intro, multi-provider, local-first
4. Three builtin difficulty templates with thumb gallery + hatch /
L99 estimates from the rebalanced curves
5. Evolution system β XP sources, algorithm core, tier multipliers,
growth curve
6. Multi-pet workflow + Template Creator pitch
7. Dashboard surface (feeding bill, chart, recent moves)
8. Pet / Template import-export with schema validation contract
9. Tech stack + from-source build recipe
Image refs all checked in (icon.png + 3 template thumbs).
Links to the algorithm source for readers who want depth.
MIT LICENSE added to match the `license = "MIT"` field already
declared in Cargo.toml β the readme-badge linking to /LICENSE now
resolves.
github-actions
Bot
added
the
docs
Addresses review feedback:
1. All-English copy (was bilingual zh/en)
2. Logo + title centered in <div align="center"> + <h1>
3. No section underlines β every section uses ### (h3) so GitHub's
auto border-bottom (which only hits h1/h2) doesn't fire
4. Per-platform "Download" buttons (shields.io for-the-badge) that
click straight to /releases/latest β install commands tucked into
a <details> dropdown below for the one-liner crowd
5. Provider mention now reads "Claude Code / Codex / OpenCode /
Aider β and more providers landing soon" instead of a fixed list
6. Added explicit safety statement:
"Zero-risk, fully local. No cloud, no telemetry, no account, no
data ever leaves your machine. Open source, MIT-licensed, fully
auditable."
7. Evolution Engine rewritten with more authority + fun:
- XP pipeline ASCII diagram
- Algorithm core formula (verbatim from algorithm.rs)
- Tier table (Frontier/Mid/Mini) with caps + multipliers
- Growth curve concrete numbers (L25β67%, L50β50%)
- Per-template personality explanation (rule_mult [0.5, 2.0])
Header audit: 1 HTML <h1> (title, single thin divider line acceptable
as title separator), 0 markdown # / ##, 10 markdown ### sections (no
underlines).
User asked for the product name "petpet" to appear above the "Real AI Pet Raising" line for clearer brand hierarchy. Hierarchy is now: π§ icon (140px) petpet β <h1>, largest, the product name Real AI Pet Raising β <h3>, secondary, the tagline italic descriptor β <p>, mood line badges β shields The <h1> still gets GitHub's default bottom-border but it now reads as an intentional divider between "the product" and "everything about it" rather than just underlining the tagline.
Plain "Download" was visually weak between the title block and the buttons. Swapped for on-theme "π₯ Pick your egg" β keeps the functional cue (it IS where you download) but reinforces the pet-raising metaphor: the binary you grab is the unhatched form, which becomes your hatched companion inside the app.
Was right-aligned (`---:`), now matches the rest of the table with center alignment (`:---:`). Visual consistency β every numeric / descriptor column in the table now centers.
User flagged it as filler. The "Build from Source" block below already implies the toolchain (Rust + Node + pnpm + tauri); the Tech Stack table mostly restated what was visible in Cargo.toml / package.json. Better signal-to-noise without it.
Replaces the old yin-yang circle icon with the project's actual brand asset β a pastel-blue starred egg with a Tamagotchi-style hand-held attached. Captures the "raise a digital pet from an egg" loop in one glance. Generated via `pnpm tauri icon` from a 1024Γ1024 source (padded to square + alpha-blended on transparent background). All platform sizes regenerated: - icon.png (512Γ512) β README + dashboard logo - icon.icns β macOS bundle - icon.ico β Windows bundle - 32x32 / 64x64 / 128x128 / @2x β Linux desktop entries - Square*Logo.png β Windows store / live tiles - android/, ios/ β future mobile if we add it (Tauri ships these by default) README already references icon.png at the old path β change is transparent to the markdown.
Two PIL-generated showcase images now live at `assets/screenshots/`: 1. three-eggs.png (860Γ340) β the stage_0 egg of each builtin template, side-by-side with difficulty dot + name + hatch-time subtitle. Replaces the abstract ASCII intro of the templates section with actual pixel art. Drops in above the templates table (existing thumbs preserved as a fallback in case the image fails to load). 2. evolution-strip-all.png (948Γ848) β all three templates' stages 0/3/6/9 laid out as horizontal evolution journeys, each with chunky right-pointing arrows between sprites and a colored difficulty dot in the row header. Replaces the placeholder ASCII diagram in the Evolution Engine section with something readers can immediately grasp. Both use transparent backgrounds so they adapt to GitHub's light/dark themes. Difficulty dots are drawn directly via ImageDraw.ellipse (instead of π’π‘π΄ emojis which don't render in PIL's default font path).
Wrapped both the three-eggs visual AND the difficulty-detail table inside the same <div align="center"> block so they read as one visually unified element instead of an image floating left and a table jammed against the margin below. The "Hard mode philosophy" paragraph stays outside the div so its left-alignment matches the rest of the body copy.
The ASCII version of the pipeline rendered unevenly β box borders
drifted because line lengths varied (the closing "ββ XP" extended
past the right wall in most rendered widths), and the arrows
didn't align across browser fonts.
Generated a 888Γ180 PNG via PIL with four rounded-rect pills
(teal sources, purple algorithm, orange rule multiplier, gold XP)
and chunky filled arrows between them. Transparent background so
GitHub light/dark themes both look clean.
Pipeline reads left-to-right at a glance, with subtitle text
inside each pill ("cross-pet invariant", "per-template
personality") preserving the semantic distinction the prose
already makes.
The user's real-desktop screenshot would have shipped the pet too
small to drive the README's first-impression. Generated a
poster-style hero (1600Γ800) instead β Pokemon-starter-card vibe β
that conveys the product story in one glance:
- "petpet" wordmark with soft glow + "Real AI Pet Raising" tagline
- Three apex forms (Unicorn / Sun / KingKong stage_9 sprites)
laid out in a row with colored halo glows behind each
- Difficulty pill chips (EASY / MEDIUM / HARD) + hatch-time
subtitles under each form
- Starry navy background (echoes the petpet logo egg's star
pattern) with corner sparkle accents
- Bottom callout: "From egg to apex β fueled by every AI
conversation"
Renders centered at width=900 under the badges block, directly
above the Download buttons. Doubles as the visual answer to
"what does this app actually look like?" and "what are the three
starter options?" without needing a real desktop screenshot.
User feedback: the PIL-generated hero felt over-produced for the project's tone, and the rounded-pill XP-pipeline diagram looked too "corporate slide" β the README's voice is closer to a hacker zine than a product page. Removed: - assets/screenshots/hero.png (the starter-card poster) - assets/screenshots/xp-pipeline.png (the rounded pill diagram) Restored the XP pipeline as a code-block text figure: Token usage β Activity ββΌβββ Algorithm βββ Rule multiplier βββ XP Manual grantsβ (invariant) (per-template) Three-eggs + evolution-strip-all stay in (kept inside their own sections where they still earn their weight β those visualise something the prose alone can't).
Two real product captures land where the prose is thinnest: 1. assets/screenshots/pet-hover.png (532Γ436) Wukong sprite + the GBA-style status panel that appears on hover (name Β· Lv.11 Β· XP bar 2003/2140 Β· "STAGE 2 β Stage 3 Β· 767 XP"). Drops into the "What is petpet?" section so the first concrete visual answer is "this is what a live pet looks like, and yes, it does have real numbers underneath." 2. assets/screenshots/dashboard.png (1408Γ1714) The full Trainer Card surface β 3-pet sidebar (Wukong / Unicorn / KingKong), All view summary ($8273.25 spend Β· 25,234 XP Β· 14.76B tokens), Claude vs Codex per-provider breakdown, and the Recent Moves audit log. Replaces the dashboard section's bullet list with the actual screenshot so readers can see the depth instead of just being told about it. Both centered under their section headers with explanatory captions. Renames "30-day chart" bullet to "Per-provider breakdown" to match what the screenshot actually shows; tightens the section header copy to use the in-app name "Trainer Card".
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
1 participant
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.
Summary
Public-facing README in the project's bilingual Chinese-tech voice. Structure:
ηζ£η AI ε―΅η©ι€ζframingxattr -crworkaround called out for macOSsrc/xp/algorithm.rs.petpetarchive shape, schema validation contractImage checks
All referenced paths exist (
desktop/src-tauri/icons/icon.png, three template thumbs,src/xp/algorithm.rs). README renders correctly in GitHub's preview.License
Adds MIT
LICENSEto back the existinglicense = "MIT"inCargo.tomlβ the README'sLICENSEbadge link previously 404'd.π€ Generated with Claude Code