Getting Started on Localization
Easydict uses Xcode String Catalog to manage translations, so the following steps are what you need to get started on localizing the app.
Installing Xcode 16+
You can install Xcode from the Mac App Store or its beta versions on Apple Developer.
Cloning and building the project
- Use git to clone the project from GitHub to your Mac. You can do this by using the git command line tool or GitHub Desktop.
- Make sure to base your changes on the dev branch, this is where localization work takes place.
- Open the project and build it. Detailed instructions are available in the developer build guide.
Adding your language to String Catalog
Now you can start to add your own language!
- Navigate to
Easydict -> Easydict -> App -> Localizable.xcstrings. This catalog contains the main app strings. Also openEasydict/App/InfoPlist.xcstringsfor app metadata and permission descriptions. - Click on the
Localizable.xcstringsfile and click the+button to find a list of available options. If you don’t see the language you want to localize on the list (e.g. Canadian English). Scroll all the way down to the bottom of the menu to findMore Languages. - After you add a language, you can start translating. Add the same language to
InfoPlist.xcstringsand translate its strings as well.
Previewing your translations
After you are done with your translations, it’s nice to run the app and go over your work. You can set the app language to the one that you did with a simple few clicks.
- Find Easydict’s icon on the top toolbar of Xcode and click on it
- Click on
Edit Scheme... - Select the
RUNtab on the left sidebar and go toOptions - Scroll down to find
App Language, then choose the one you localized for - Close the tab and use ⌘R to run the app and see your translations
Pushing your changes to GitHub
After you finish checking your localization, it’s time to push the changes to GitHub and start a pull request.
- Start a Pull Request.
- Remember to set the merge target to the
devbranch
Now you can wait for a maintainer’s review and get your translations adopted in the next release version.