summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorsyuilo <syuilotan@yahoo.co.jp>2018-04-16 04:53:55 +0900
committersyuilo <syuilotan@yahoo.co.jp>2018-04-16 04:53:55 +0900
commit1fa0733d437aa854b9278ce5477d96399fc5cb14 (patch)
treeb07854558edd8ec7b7abfae8b188807de67e4373 /docs
parentMerge pull request #1482 from Conan-kun/patch-2 (diff)
downloadmisskey-1fa0733d437aa854b9278ce5477d96399fc5cb14.tar.gz
misskey-1fa0733d437aa854b9278ce5477d96399fc5cb14.tar.bz2
misskey-1fa0733d437aa854b9278ce5477d96399fc5cb14.zip
Move doc to /docs
Diffstat (limited to 'docs')
-rw-r--r--docs/translate.en.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/translate.en.md b/docs/translate.en.md
new file mode 100644
index 0000000000..6108f2cb3e
--- /dev/null
+++ b/docs/translate.en.md
@@ -0,0 +1,27 @@
+Misskey's Translation - English version
+============
+
+How to add a new language?
+----------------------
+Please copy a language file to /locales and rename it to the name of the language you want to add and edit.
+
+If you find an untranslated part on Misskey:
+-------------------------------
+
+1. Please look for untranslated parts from Misskey source code.
+ - For instance, if you find an untranslated part in: `src/client/app/mobile/views/pages/home.vue`.
+
+2. Replace the untranslated portion with a character string of the form `%i18n:@hoge%`.
+ - In fact, `hoge` should be a word that is appropriate for the situation and is easy to understand in English.
+ - For example, if the untranslated portion is the text「タイムライン」you must write: `%i18n:@timeline%`.
+
+3. Open each language file in /locales, check whether the <strong>file name (path)</strong> found in step 1 exists, if not, create it.
+ - Do not put `src/client/app/`.
+ - For example, in this case we want to modify untranslated parts of `src/client/app/mobile/views/pages/home.vue`, so the key is `mobile/views/pages/home.vue`.
+
+4. Add the translated text property using the `hoge` key below the path that you found or created in step 2. Beside, please enter in quotation marks the value of your translation in each language file.
+ - For example, in this case we add timeline: `timeline: "Timeline"` to `locales/en.yml`, and `timeline: "タイムライン"` to `locales/ja.yml`.
+
+5. It's done!
+
+For more details, please refer to this [commit](https://github.com/syuilo/misskey/commit/10f6d5980fa7692ccb45fbc5f843458b69b7607c).