FaceVerificationSDK icon indicating copy to clipboard operation
FaceVerificationSDK copied to clipboard

Add Multilanguage Support for Application Code and Documentation

Open waqarmumtaz369 opened this issue 1 year ago • 3 comments

Description

Hello,

I am Waqar Mumtaz, and I have expertise in facial detection, recognition, and feature extraction on Android. I have come across your face verification SDK for Android and found it very impressive. I noticed that the application currently supports only one language. I would like to propose adding multilanguage support to the application, as well as translating the documentation and code comments into English.

Benefits

  1. Increased Accessibility: Supporting multiple languages will make the application usable by a broader audience.
  2. Enhanced User Experience: Users will be able to choose their preferred language, improving their overall experience.
  3. Improved Documentation: Translating the documentation and code comments will help developers worldwide understand and contribute to the project.

Plan

  1. Documentation:

    • Create separate documentation files for each language (e.g., README.md for English and README_zh.md for Chinese).
    • Update the main README.md file to include links to both language versions.
  2. Code Comments:

    • Include multilingual comments directly in the code, with both Chinese and English comments.
  3. Application Code:

    • Use Android's localization features to support both Chinese and English languages.
    • Create values and values-zh directories to store string resources.
    • Update the application code to reference these string resources.
    • Optionally, add a feature to allow users to switch languages within the app.
  4. Directory Structure:

    • Organize the documentation into language-specific directories (e.g., docs/en and docs/zh).
  5. Language Switcher:

    • Add links in the main README.md and other relevant places to allow easy switching between languages.

Request

Please let me know if you would be interested in this contribution. I am happy to start as soon as I get your approval and any specific guidelines or preferences you might have for the translation and multilanguage support.

Thank you for considering my proposal. I look forward to your response.

Best regards,
Waqar Mumtaz


Note: Feel free to ask any questions or provide additional information on how you would like the translation and multilanguage support to be handled.

waqarmumtaz369 avatar May 26 '24 13:05 waqarmumtaz369