Skip to content

Add Simplified Chinese and Korean READMEs #59

Description

@ejboy

Add Simplified Chinese and Korean READMEs

Goal

Add localized README versions for Scriptella in:

  • Simplified Chinese
  • Korean

The English README.md remains the canonical project documentation.

Also expose these translations from scriptella.org through a compact language menu without localizing the website itself.

Motivation

Recent Scriptella website traffic shows meaningful usage from both China and South Korea. Localized READMEs can improve accessibility, discovery, and make it clearer that users in these markets are supported.

This issue is intentionally limited to these two languages.

Repository scope

Add:

  • README.zh-CN.md
  • README.ko.md

On the main English README.md, add the language links immediately below the badges and before the opening description:

[简体中文](README.zh-CN.md) · [한국어](README.ko.md)

Scriptella is a lightweight, XML-driven ETL and database migration tool for
Java...

Do not add an English | ... selector to the main README.

Each localized README should cover the full user-facing README content closely enough that a Chinese- or Korean-speaking user can evaluate and start using Scriptella without switching back to English for the basic workflow.

Translation rules

  • Prefer natural technical Chinese and Korean rather than literal sentence-by-sentence translation.
  • Preserve commands, XML, Maven coordinates, URLs, artifact names, class names, and other technical identifiers exactly.
  • Do not translate product or technology names such as Scriptella, Java, Maven, JDBC, GitHub, or Maven Central.
  • Keep the structure broadly aligned with the English README so future updates are easy to propagate.
  • The English README.md remains authoritative if translated wording or technical details diverge.
  • Do not translate the broader documentation site as part of this issue.

Localized README navigation

Near the top of README.zh-CN.md, include:

[English](README.md) · 简体中文 · [한국어](README.ko.md)

Near the top of README.ko.md, include:

[English](README.md) · [简体中文](README.zh-CN.md) · 한국어

Place these consistently near the badges / opening section.

Website update

Add a small language selector to scriptella.org.

Place a globe/language icon next to the existing light/dark theme control.

Do not use a country flag for the language selector.

Clicking the globe should open a small dropdown with:

  • English — Website
  • 简体中文 — README
  • 한국어 — README

Behavior:

  • English should point to the normal Scriptella website/homepage.
  • 简体中文 should point to README.zh-CN.md on GitHub.
  • 한국어 should point to README.ko.md on GitHub.
  • Make it clear through the README label that the Chinese and Korean links lead to localized README documentation rather than localized versions of the website.

Keep the UI visually consistent with the existing theme selector and avoid adding prominent language links to the main homepage content.

Do not add /zh-cn/, /ko/, or other localized website pages as part of this issue.

Maintenance

Keep release-sensitive information synchronized with the English README, especially:

  • latest Scriptella version
  • Java requirements
  • installation commands
  • Maven coordinates
  • support and documentation links

The localized READMEs should not introduce independent product claims or documentation that does not exist in the canonical README.

Acceptance criteria

  • README.zh-CN.md provides a complete and natural Simplified Chinese version of the user-facing README.
  • README.ko.md provides the equivalent Korean version.
  • The English README contains only the compact Chinese and Korean links below the badges.
  • Each localized README links to the other two language versions.
  • Commands, code samples, URLs, Maven coordinates, and technical identifiers remain correct.
  • English README.md remains the canonical source.
  • scriptella.org has a globe/language control next to the theme selector.
  • The language dropdown contains English, Simplified Chinese, and Korean.
  • Chinese and Korean entries are clearly identified as README links and open the corresponding GitHub translations.
  • No localized website pages or additional languages are added.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions