diff --git a/.github/readme/localize_add.png b/.github/readme/localize_add.png new file mode 100644 index 0000000..eec0fe2 Binary files /dev/null and b/.github/readme/localize_add.png differ diff --git a/.github/readme/localize_sidebar.png b/.github/readme/localize_sidebar.png new file mode 100644 index 0000000..50e25cb Binary files /dev/null and b/.github/readme/localize_sidebar.png differ diff --git a/.github/readme/localize_sidebar_agent.png b/.github/readme/localize_sidebar_agent.png new file mode 100644 index 0000000..14bd93e Binary files /dev/null and b/.github/readme/localize_sidebar_agent.png differ diff --git a/.github/readme/localize_translate.png b/.github/readme/localize_translate.png new file mode 100644 index 0000000..6d859dd Binary files /dev/null and b/.github/readme/localize_translate.png differ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1e0eb95..8503c33 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,6 +14,10 @@ Secretive is designed to be easily auditable by people who are considering using All contributors must abide by the [Code of Conduct](CODE_OF_CONDUCT.md) +## Localization + +If you'd like to contribute a translation, please see [Localizing](LOCALIZING.md) to get started. + ## Credits If you make a material contribution to the app, please add yourself to the end of the [credits](https://github.com/maxgoedjen/secretive/blob/main/Secretive/Credits.rtf). diff --git a/LOCALIZING.md b/LOCALIZING.md new file mode 100644 index 0000000..a72e72f --- /dev/null +++ b/LOCALIZING.md @@ -0,0 +1,45 @@ +# Localizing Secretive + +If you speak another language, and would like to help translate Secretive to support that language, we'd love your help! + +## Getting Started + +### Download Xcode + +Download the latest version of Xcode (at minimum, Xcode 15) from [Apple](http://developer.apple.com/download/applications/). + +### Clone Secretive + +Clone Secretive using [these instructions from GitHub](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository). + +### Open Secretive + +Open [Sources/Secretive.xcodeproj](Sources/Secretive.xcodeproj) in Xcode. + +### Localize the Main App + +Navigate to [Secretive/Localizable](Sources/Secretive/Localizable.xcstrings). + +Screenshot of Xcode navigating to the Localizable file + +If your language already has an in-progress localization, select it from the list. If it isn't there, hit the "+" button and choose your language from the list. + +Screenshot of Xcode adding a new language + +Start translating! You'll see a list of english phrases, and a space to add a translation of your language. + +### Localize SecretAgent + +Navigate to [Secretive/Localizable](Sources/SecretAgent/Localizable.xcstrings). + +Screenshot of Xcode navigating to the Localizable file + +Repeat the same steps from the process of localizing the main app. + +### Create a Pull Request + +Push your changes and open a pull request. + +### Questions + +Please open an issue if you have a question about translating the app. I'm more than happy to clarify any terms that are ambiguous or confusing. Thanks for contributing!