Status: active
Date: 2026-06-01
Applies to: simplicio-mapper
This README pattern was built after reviewing:
- Lum1104/Understand-Anything, which had about 47.5k stars on 2026-06-01. It wins attention with a centered title, one-sentence category, language selector, badges, hero screenshot, live demo, quick start, multi-platform install, community link, under-the-hood section, and Star History chart.
- microsoft/vscode, vercel/next.js, ollama/ollama, supabase/supabase, langchain-ai/langchain, rustdesk/rustdesk, ant-design/ant-design, and open-webui/open-webui, all above 50k stars in the current benchmark pull.
- Centered product title.
- One strong promise in the first viewport.
- Trust badges: GitHub stars, package version where applicable, language/runtime, license.
- Language selector with the full Simplicio language set.
- Real visual asset or chart, not decorative filler.
- Project DNA: a short project-specific narrative that explains why this repo exists and what makes it real.
- Quick Start before long architecture reference.
- What it does, expressed as outcomes instead of internal implementation first.
- Proof and validation: benchmarks, tests, mapper artifacts, smoke flow, or known blocker.
- Simplicio ecosystem graph.
- Documentation links.
- Original project guide / Project DNA archive: restore the strongest pre-existing README material instead of replacing it.
- Star History chart.
- License / production note.
- English: root
README.mdplusREADMEs/README.en.md. - Portuguese:
READMEs/README.pt-BR.md. - Spanish:
READMEs/README.es-ES.md. - Japanese:
READMEs/README.ja-JP.md. - Korean:
READMEs/README.ko-KR.md. - Simplified Chinese:
READMEs/README.zh-CN.md. - Italian:
READMEs/README.it-IT.md. - French:
READMEs/README.fr-FR.md. - Russian:
READMEs/README.ru-RU.md. - Polish:
READMEs/README.pl-PL.md. - Hindi:
READMEs/README.hi-IN.md. - Arabic:
READMEs/README.ar-SA.md. - Hebrew:
READMEs/README.he-IL.md. - Malay:
READMEs/README.ms-MY.md. - Indonesian:
READMEs/README.id-ID.md.
- Product: simplicio-mapper
- GitHub slug used by badges and Star History:
wesleysimplicio/simplicio-mapper - Hero asset:
assets/llm-project-mapper-hero.png - Package surfaces: PyPI
simplicio-mapper, npm@wesleysimplicio/llm-project-mapper - Primary quick-start command:
pip install -U simplicio-mapper
- A globalization pass must add discovery value without deleting the repo-specific operating manual. Keep benchmarks, setup notes, domain details, architecture explanations, screenshots, caveats, and reproduction commands unless they are false.
- Treat the centered hero, badges, language selector and Star History as the front door; treat the restored guide as the workshop. Both layers are required.
- Keep commands copy-pasteable and do not translate command flags.
- Keep the first paragraph localized in every language; deep reference docs may remain in English until a release needs full translation.
- Update this file whenever the README structure changes.
- If a badge, hero, Star History chart, or package link stops rendering, fix it before release.
- When the repo has a changelog or explicit version, a release-relevant README refresh gets a patch bump.