puter icon indicating copy to clipboard operation
puter copied to clipboard

Translate README.md from English to Chinese

Open jelveh opened this issue 1 year ago • 3 comments

We need to create a Chinese version of our README to make our project more accessible to Chinese-speaking users and contributors.

Task Description

  • Translate the content of ./doc/i18n/README.en.md to Chinese
  • Create a new file ./doc/i18n/README.zh.md with the translated content
  • Ensure the format and styling of the original English README is preserved exactly in the Chinese version

Steps

  1. Copy the existing README.en.md file to create README.zh.md in the same directory (./doc/i18n/)
  2. Translate all text content from English to Chinese, including:
    • Headings
    • Paragraphs
    • Lists
    • Code comments (if any)
    • Any other textual content
  3. Preserve all markdown formatting, including:
    • Heading levels
    • Bold and italic text
    • Links
    • Code blocks
    • Tables
    • Images
  4. Ensure all links and references remain functional in the Chinese version
  5. Update any language-specific content (e.g., language badges) to reflect Chinese instead of English

Additional Considerations

  • Maintain consistent terminology throughout the translation
  • Pay attention to technical terms that may have specific translations or may need to remain in English
  • If there are any culture-specific examples or references, consider adapting them for a Chinese-speaking audience if appropriate

Definition of Done

  • [ ] README.zh.md file created in ./doc/i18n/ directory
  • [ ] All content accurately translated to Chinese
  • [ ] Format and styling match the original English version exactly
  • [ ] All links and references are functional
  • [ ] Translation reviewed by a native Chinese speaker (if possible)
  • [ ] Update project documentation or configuration to include the new Chinese README (if necessary)

Resources

  • Original English README: ./doc/i18n/README.en.md
  • GitHub Markdown Guide for reference on markdown syntax

jelveh avatar Aug 14 '24 08:08 jelveh

can I help? with my first language Chinese.

Sam-SSTU avatar Aug 19 '24 08:08 Sam-SSTU

@Sam-SSTU thank you very much. Assigned. Let me know if you need help 🙌

jelveh avatar Aug 19 '24 13:08 jelveh

https://github.com/HeyPuter/puter/pull/702 fixed, we can close this issue now!

Sam-SSTU avatar Aug 20 '24 02:08 Sam-SSTU