##########################
# Content of the archive #
##########################

A translation archive includes:

 * "polyphone_XX.qm", a file used by the Polyphone software to provide a translation;
 * "polyphone_XX.ts", a work file used to edit a translation and build the corresponding .qm file;
 * this "readme.txt" file.

Note: "XX" refers to the translation provided by the package.


##################################
# How to install the translation #
##################################

To install the translation, you need to copy "polyphone_XX.qm" into a directory, which is different depending on your system.


### For Windows ###

Create a "translations" directory next to "polyphone.exe" in "Program Files/Polyphone". Copy "polyphone_XX.qm" into this directory. Restart Polyphone and the translation will be available in the software preferences.

Program Files
|- Polyphone
|  |- translations
|  |  |- polyphone_XX.qm
|  |- polyphone.exe


### For Mac OS X ###

Display the hidden files and directories using the command "defaults write com.apple.finder AppleShowAllFiles YES" in a terminal. Then restart the "Finder" application.
Go to the directory containing Polyphone's local settings in "$HOME/Library/Preferences/". Create a "translations" directory next to the file "com.polyphone.Polyphone.plist" and copy "polyphone_XX.qm" into this directory.
You can then hide the hidden files with the command "defaults write com.apple.finder AppleShowAllFiles NO" in a terminal. Restart Polyphone: the translation will be available in the software preferences.

Library
|- Preferences
|  |- translations
|  |  |- polyphone_XX.qm
|  |- com.polyphone.Polyphone.plist


### For Linux ###

Go to the directory containing Polyphone's local settings in "$HOME/.config/polyphone". Create a "translations" directory next to the file "Polyphone.conf" and copy "polyphone_XX.qm" into this directory. Restart Polyphone: the translation will be available in the software preferences.

.config
|- polyphone
|  |- translations
|  |  |- polyphone_XX.qm
|  |- Polyphone.conf


############################################
# How to improve or complete a translation #
############################################

If you want to take part in a translation, you will need:

 * the work file "polyphone_XX.ts",
 * the "Qt Linguist" software,
 * patience!

For more information, please visit this page:
https://www.polyphone.io/en/documentation/development/translate-polyphone
