docs: rewrite README and translations to be beginner-friendly and comprehensive #24

Closed
opened 2026-04-05 19:44:24 +02:00 by MrUnknownDE · 0 comments
Owner

Originally created by @gabrielalmir on 2/10/2026

What changed

New sections added

  • Beginner-friendly introduction — Explains what GIMP is and how PhotoGIMP relates to it, so first-time users aren't lost
  • Requirements table — Clear prerequisites (GIMP 3.0+, must run GIMP once first)
  • "What's Inside the Patch" — Detailed table explaining every config file PhotoGIMP modifies
  • How to Uninstall — Per-OS instructions to restore GIMP to defaults or from backup
  • Troubleshooting / FAQ — Collapsible answers to 6 common questions (wrong folder, version mismatch, GIMP 2.10 compatibility, custom assets safety, shortcut customization, updating)
  • Contributing — Links to issues and PRs
  • Translations — Cross-links between all language versions
  • License — Footer linking to LICENSE file
  • Repo badges — Stars, license, and latest release badges

Improved existing sections

  • Backup instructions promoted — Moved from a small tip at the bottom to a visible > [!WARNING] block before install steps, with dedicated backup sub-sections per OS
  • Install steps expanded — Added "why" explanations (e.g., "this creates the config folders that PhotoGIMP needs"), explicit paths, and hidden folder tips for Linux
  • Chocolatey & icon change — Moved into collapsible <details> blocks to reduce clutter
  • Features — Each feature now has a short description instead of just a bullet title
  • Fixed typos — e.g., "thes files" → "the files"
*Originally created by @gabrielalmir on 2/10/2026* ## What changed ### New sections added - **Beginner-friendly introduction** — Explains what GIMP is and how PhotoGIMP relates to it, so first-time users aren't lost - **Requirements table** — Clear prerequisites (GIMP 3.0+, must run GIMP once first) - **"What's Inside the Patch"** — Detailed table explaining every config file PhotoGIMP modifies - **How to Uninstall** — Per-OS instructions to restore GIMP to defaults or from backup - **Troubleshooting / FAQ** — Collapsible answers to 6 common questions (wrong folder, version mismatch, GIMP 2.10 compatibility, custom assets safety, shortcut customization, updating) - **Contributing** — Links to issues and PRs - **Translations** — Cross-links between all language versions - **License** — Footer linking to LICENSE file - **Repo badges** — Stars, license, and latest release badges ### Improved existing sections - **Backup instructions promoted** — Moved from a small tip at the bottom to a visible `> [!WARNING]` block before install steps, with dedicated backup sub-sections per OS - **Install steps expanded** — Added "why" explanations (e.g., *"this creates the config folders that PhotoGIMP needs"*), explicit paths, and hidden folder tips for Linux - **Chocolatey & icon change** — Moved into collapsible `<details>` blocks to reduce clutter - **Features** — Each feature now has a short description instead of just a bullet title - **Fixed typos** — e.g., "thes files" → "the files"
Sign in to join this conversation.