aboutsummaryrefslogtreecommitdiff
path: root/docs/source/develop.rst
diff options
context:
space:
mode:
authorMicah Lee <micah@micahflee.com>2020-08-26 13:51:25 -0700
committerMicah Lee <micah@micahflee.com>2020-08-26 13:51:25 -0700
commit0d174f80e5ab613e62e42bbb1abc36372dc84634 (patch)
tree4bedc7a252777cd298283705db9af115340abff1 /docs/source/develop.rst
parent638f48b128c62dd3e3a67cab16d99f9cb54a83d1 (diff)
downloadonionshare-0d174f80e5ab613e62e42bbb1abc36372dc84634.tar.gz
onionshare-0d174f80e5ab613e62e42bbb1abc36372dc84634.zip
Split tor into its own separate page, and add translation docs to develop
Diffstat (limited to 'docs/source/develop.rst')
-rw-r--r--docs/source/develop.rst34
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/source/develop.rst b/docs/source/develop.rst
index 1d9ec908..7d35d4e9 100644
--- a/docs/source/develop.rst
+++ b/docs/source/develop.rst
@@ -173,3 +173,37 @@ If you want to obtain debug output from the ``onionshare-gui.exe`` in Windows, y
Then rebuild the EXE with ``install\build_exe.bat`` (you may need to comment out the ``signtool`` commands in the ``build_exe.bat`` and the ``onionshare.nsi`` files, as per the ``BUILD.md`` instructions).
After this, you can run ``onionshare-gui.exe -v`` from a command prompt to see the debug output.
+
+Contributing Translations
+-------------------------
+
+Most of the OnionShare is translatable. You can help make it easier to use and more familiar and welcoming for people around the globe. The Localization Lab has some `documentation about translating OnionShare <https://wiki.localizationlab.org/index.php/OnionShare>`_.
+
+OnionShare uses Weblate to keep track of translations. You can view the OnionShare project here: https://hosted.weblate.org/projects/onionshare/
+
+To help translate, make a Hosted Weblate account and start contributing to that project.
+
+Suggestions for original English strings
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sometimes the original English strings could be improved, making them easier to translate into other languages.
+
+If you have suggestions for a better English string, please open a GitHub issue rather than commenting in Weblate. This ensures the upstream developers will definitely see the suggestion, and can potentially modify the string via the usual code review processes.
+
+Status of translations
+^^^^^^^^^^^^^^^^^^^^^^
+Here is the current translation status. If you want start a translation in a language not to be found here, please write us to the mailing list: onionshare-dev@lists.riseup.net
+
+.. image:: https://hosted.weblate.org/widgets/onionshare/-/translations/multi-auto.svg
+
+Translate the .desktop file
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+You can also translate the ``install/onionshare.desktop`` file.
+
+Duplicate the line that begins with ``Comment=``. Add the language code to the new line so it becomes ``Comment[lang]=`` (lang should be your language). You can see what language codes are used for translation by looking at the ``share/locale/*.json`` filenames::
+
+ Comment=Original string
+ Comment[da]=Danish translation of the original string
+
+Do the same for other untranslated lines. \ No newline at end of file