Skip to content

Latest commit

 

History

History
65 lines (53 loc) · 3.69 KB

File metadata and controls

65 lines (53 loc) · 3.69 KB

README Globalization Standard

Status: active
Date: 2026-06-01
Applies to: simplicio-mapper

Benchmark Input

This README pattern was built after reviewing:

Required README Order

  1. Centered product title.
  2. One strong promise in the first viewport.
  3. Trust badges: GitHub stars, package version where applicable, language/runtime, license.
  4. Language selector with the full Simplicio language set.
  5. Real visual asset or chart, not decorative filler.
  6. Project DNA: a short project-specific narrative that explains why this repo exists and what makes it real.
  7. Quick Start before long architecture reference.
  8. What it does, expressed as outcomes instead of internal implementation first.
  9. Proof and validation: benchmarks, tests, mapper artifacts, smoke flow, or known blocker.
  10. Simplicio ecosystem graph.
  11. Documentation links.
  12. Original project guide / Project DNA archive: restore the strongest pre-existing README material instead of replacing it.
  13. Star History chart.
  14. License / production note.

Required Languages

  • English: root README.md plus READMEs/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.

Project-Specific Checklist

  • 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

Maintenance Rules

  • 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.