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

Localizing help pages #501

Merged
merged 4 commits into from
Jan 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .github/readme/localize_add.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/readme/localize_sidebar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/readme/localize_sidebar_agent.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/readme/localize_translate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
45 changes: 45 additions & 0 deletions LOCALIZING.md
Original file line number Diff line number Diff line change
@@ -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).

<img src="/.github/readme/localize_sidebar.png" alt="Screenshot of Xcode navigating to the Localizable file" width="300">

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.

<img src="/.github/readme/localize_add.png" alt="Screenshot of Xcode adding a new language" width="600">

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).

<img src="/.github/readme/localize_sidebar_agent.png" alt="Screenshot of Xcode navigating to the Localizable file" width="300">

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!