diff --git a/README.md b/README.md index 35c3c21..c55ed83 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,7 @@ - [Getting Started](#toolbox-getting-started) - [Download](#floppy_disk-download) - [Development](#gear-development) + - [Localisation](#speech_balloon-localisation) - [Builds](#triangular_flag_on_post-builds) - [Roadmap](https://github.com/users/othyn/projects/1) @@ -132,6 +133,29 @@ Build and run through Xcode as you normally would to a macOS target. As a note, This is a side project, so feel free to submit a PR for any functionality/bug fixes and go ham. There aren't any contributing guidelines as of yet, code style is handled by `swiftlint` (`$ brew install swiftlint`) and should automatically fix the style upon build (there is a GH Action setup for this also). +### :speech_balloon: Localisation + +This project supports localisation! Please see the pinned [language support issue](https://github.com/othyn/macos-auto-clicker/issues/10) as a discussion place for new language support. See the [`auto-clicker/Localisation`](https://github.com/othyn/macos-auto-clicker/tree/main/auto-clicker/Localisation) project directory to view currently supported languages, the project default being `en-GB`. + +The project makes use of the Apple default `Localizable.strings` and `Localizable.stringsdict` to support local translations. See [issue #36](https://github.com/othyn/macos-auto-clicker/issues/36) for some useful links and resources for implementing translations. The short tutorial is; + +0. Clone this project locally to somewhere on your machine. +1. Open up the project **workspace** in Xcode. +2. Click on the top level project item in the project file browser sidebar in Xcode. +3. Click on the project under the Project heading. +4. Click on the 'Info' tab. +5. Scroll down to 'Localizations'. +6. Click the plus button at the bottom of the table displaying the current project languages and select the language you intend to provide translations for. +7. On the on screen prompt **change nothing** and just click 'Finish' +8. The new language will appear in the `Localisation` folder as a new version of the `Localizable.strings` file, with the language code identifier along with the file and appearing as the parent directory in the `Localisation` folder. E.g. for France this would be `fr`. You will know if the translation file has been picked up by Xcode as the language will appear with the amount of `Localizable.strings` translation files found by Xcode in that 'Localizations' table mentioned in step 5. +9. Once you have written the translations by providing the appropriate new strings in the language you've chosen as are required by the application, please submit a new PR to merge in the new language as a supported language. + +