Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Translate README.md from English to Malayalam #752

Closed
6 tasks
jelveh opened this issue Sep 4, 2024 · 7 comments
Closed
6 tasks

Translate README.md from English to Malayalam #752

jelveh opened this issue Sep 4, 2024 · 7 comments
Assignees
Labels
good first issue Good for newcomers help wanted Extra attention is needed translation Translation and localization

Comments

@jelveh
Copy link
Contributor

jelveh commented Sep 4, 2024

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

Task Description

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

Steps

  1. Copy the existing README.en.md file to create README.ml.md in the same directory (./doc/i18n/)
  2. Translate all text content from English to Malayalam, 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 Malayalam version
  5. Update any language-specific content (e.g., language badges) to reflect Malayalam 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 Malayalam-speaking audience if appropriate

Definition of Done

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

Resources

  • Original English README: ./doc/i18n/README.en.md
  • GitHub Markdown Guide for reference on markdown syntax
@jelveh jelveh added good first issue Good for newcomers help wanted Extra attention is needed translation Translation and localization labels Sep 4, 2024
@rinogodson
Copy link
Contributor

I would love to translate the README.md to Malayalam

@jelveh
Copy link
Contributor Author

jelveh commented Sep 5, 2024

Awesome. Assigned! Let me know if you need any help 🫡

@rinogodson
Copy link
Contributor

I’ve submitted a pull request with a Malayalam translation for the README.md file.

@jelveh
Copy link
Contributor Author

jelveh commented Sep 5, 2024

Merged! Thank you for translating Puter's README into Malayalam.
I just created another issues for translating Puter itself into Malayalam. It's a bit more work but it would be super cool to have Puter itself available in Malayalam as well. Leave a comment there if you're interested in picking it up!

Thanks again! 😇

@jelveh jelveh closed this as completed Sep 5, 2024
@rinogodson
Copy link
Contributor

Thank you for merging the PR! 😇

I’d love to work on translating Puter itself into Malayalam, but I’m not familiar with the file system and structure of the project. Could you provide me with some guidance or steps on how to get started with the translation? It would really help me contribute effectively.

Looking forward to your instructions!

@jelveh
Copy link
Contributor Author

jelveh commented Sep 5, 2024

Sure thing! I just updated this issue: #754 with step-by-step instructions on how to get started translating Puter into Malayalam. Please take a quick look and let me know if you have any questions, I'd be happy to help.

(please note that I linked earlier to the same issue but it the issue description was completely wrong, I fixed that as well)

@rinogodson
Copy link
Contributor

I'll do my best

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed translation Translation and localization
Projects
None yet
Development

No branches or pull requests

2 participants