Skip to content

docs: add Simplified Chinese README translation (README_zh.md) - #2186

Closed
WanderLandWalker wants to merge 1 commit into
jarun:masterfrom
WanderLandWalker:zh-readme
Closed

WanderLandWalker wants to merge 1 commit into
jarun:masterfrom
WanderLandWalker:zh-readme

Conversation

@WanderLandWalker

Copy link
Copy Markdown

What this does

Adds a Simplified Chinese translation of the README as README_zh.md to help Chinese-speaking developers discover and adopt nnn.

  • Purely additive: one new file, no existing files modified.
  • Preserved unchanged (byte-for-byte): the HTML wrapper tags and structure (<h3 align="center">, the <p align="center"> badge block, <img …>, <a …>); all image src/alt values — the logo alt="nnn", the six shields badges including the percent-encoded/special glyphs (privacy-✓-crimson, ©-BSD%202--Clause, ?maxAge=600&label=rel, label=CircleCI, ?branch=master), the Demoshell badge (alt="Live demo by Demoshell" align="absmiddle", snapshot=demoshell%2Ftui%3Annn), the two user-attachments screenshot links (including the empty-alt ![] video thumbnail); the $~~$ nav separators; every <kbd> tag (~, -, @, /, q, Tab, ?); the single ```sh ``` quickstart command and every inline-code identifier (nnn, sshfs, rclone, cd, cp, mv, rm, $EDITOR, $PWD, ls, -e, -c, -x, NNN_OPENER, nuke, xopen, alias l='nnn -dDe', /proc); the _n³_ term and the :sunglasses: shortcode; and every URL.
  • The nav bar links are absolute (https://github.com/jarun/nnn#features, …#quickstart, …plugins#nnn-plugins, …/wiki), so they still point at the canonical English README on GitHub — translating the local headings does not affect them. The source README contains no in-page ](#…) anchor links, so nothing needed to be pinned.
  • Translated: the prose, the section headings (功能特性 / 快速上手 / 视频 / 媒体报道 / 开发者), the full feature bullet list, the Quickstart numbered steps, the italic <i>Supercharge your productivity!</i> tagline, the nav display labels (功能 / 快速上手 / 插件), and human-readable link display text.
  • Left in their original form (these are names, not prose): the contributor list (developer names and the Copyright © 2016-2026 line), the YouTube video titles and the publication/article titles under Videos and 媒体报道, and proper nouns/platform/tool identifiers (Linux, macOS, BSD, Haiku, Cygwin, WSL, Termux, Neovim, FreeDesktop, xterm, POSIX/PCRE2, FUSE, FPU, Unicode, nnn.vim/nnn.nvim).
  • A top banner links back to the canonical English README.md.

Note on AI assistance

This translation was produced with AI assistance and independently reviewed for accuracy, formatting, and license/compliance before submission. The project is BSD-2-Clause licensed.

Becoming a Contributor

I checked for a CONTRIBUTING.md, a pull-request template, and any AI/LLM restriction or issue-first/DCO/CLA gate in the repository and found none — nnn's README only softly invites discussion of new ideas — so this purely additive docs file follows the normal fork → pull-request flow. I would love to become a Contributor to this repository, and I'm happy to match any preferred convention for README translations and to keep the translation in sync as the English README evolves.

@N-R-K

N-R-K commented Oct 19, 2026

Copy link
Copy Markdown
Collaborator

I don't think there's any reason for us to maintain multiple language readme when translation tools nowadays are good enough.

@WanderLandWalker

Copy link
Copy Markdown
Author

I don't think there's any reason for us to maintain multiple language readme when translation tools nowadays are good enough.

I see your point—translation tools are good enough now. Still, multilingual READMEs lower the barrier for non-English users and show inclusivity. We could also keep only a few key languages or automate to reduce maintenance.
Do you want me to close this PR, or is there anything else you'd like me to change? Thanks.

@N-R-K

N-R-K commented Oct 19, 2026

Copy link
Copy Markdown
Collaborator

multilingual READMEs lower the barrier for non-English users

nnn, the software itself, is fully English without any translations.

Do you want me to close this PR, or is there anything else you'd like me to change?

Up to @jarun, I personally don't see any value in this unless we want to add translation to nnn itself first.

@WanderLandWalker

Copy link
Copy Markdown
Author

multilingual READMEs lower the barrier for non-English users

nnn, the software itself, is fully English without any translations.

Do you want me to close this PR, or is there anything else you'd like me to change?

Up to @jarun, I personally don't see any value in this unless we want to add translation to nnn itself first.

Thanks for the feedback—that's a fair point. If nnn itself has no translations, a multilingual README alone has limited value. I'm happy to close this PR, or leave it to @jarun to decide—just let me know if you'd like me to close it.
Alternatively, we could consider adding translations to nnn itself; I'd be glad to help with that if it's something you'd be interested in.
Thanks.

@jarun

jarun commented Oct 22, 2026

Copy link
Copy Markdown
Owner

Not required. Thanks!

@jarun jarun closed this Oct 22, 2026
@WanderLandWalker

Copy link
Copy Markdown
Author

Not required. Thanks!

Understood, thanks for letting me know!

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants