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 Italian #687

Closed
6 tasks
jelveh opened this issue Aug 15, 2024 · 2 comments
Closed
6 tasks

Translate README.md from English to Italian #687

jelveh opened this issue Aug 15, 2024 · 2 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed translation Translation and localization

Comments

@jelveh
Copy link
Contributor

jelveh commented Aug 15, 2024

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

Task Description

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

Steps

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

Definition of Done

  • README.it.md file created in ./doc/i18n/ directory
  • All content accurately translated to Italian
  • Format and styling match the original English version exactly
  • All links and references are functional
  • Translation reviewed by a native Italian speaker (if possible)
  • Update project documentation or configuration to include the new Italian 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 Aug 15, 2024
@VinayakPaka
Copy link
Contributor

I would like to work on this issue. Can You please assign this issue to me.

@jelveh
Copy link
Contributor Author

jelveh commented Aug 20, 2024

closed via #703

@jelveh jelveh closed this as completed Aug 20, 2024
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