Browse Source

add docs-translations deprecation README

Zeke Sikelianos 7 years ago
parent
commit
11957b62bb
1 changed files with 33 additions and 0 deletions
  1. 33 0
      docs-translations/README.md

+ 33 - 0
docs-translations/README.md

@@ -0,0 +1,33 @@
+## Docs Translations
+
+This directory once contained unstructured translations of Electron's 
+documentation, but has been deprecated in favor of a new translation process 
+using [Crowdin], a GitHub-friendly platform for collaborative translation.
+
+For more details, visit the [electron/electron-i18n] repo.
+
+## Contributing
+
+If you're interested in helping translate Electron's docs, visit 
+[crowdin.com/projects/electron] and log in with your GitHub account. And thanks!
+
+## Offline Docs
+
+If you miss having access to Electron's raw markdown files in your preferred
+language, don't fret! You can still get raw docs, they're just in a 
+different place now. See [electron/electron-i18n/tree/master/content]
+
+To more easily view and browse offline docs in your language, clone the repo and use [vmd], 
+an Electron-based GitHub-styled markdown viewer:
+
+```sh
+npm i -g vmd
+git clone https://github.com/electron/electron-i18n
+vmd electron-i18n/content/zh-CN
+```
+
+[crowdin.com/projects/electron]: https://crowdin.com/projects/electron
+[Crowdin]: https://crowdin.com/projects/electron
+[electron/electron-i18n]: https://github.com/electron/electron-i18n#readme
+[electron/electron-i18n/tree/master/content]: https://github.com/electron/electron-i18n/tree/master/content
+[vmd]: http://ghub.io/vmd