deps/libretro-common/samples/core_options/example_translation/translation scripts/instructions.txt

   1 Place 'crowdin.yml' & the 'intl' and '.github' folder, including content, into the root of the repo.
   2
   3 In '.github/workflows' are two files: 'crowdin_intl.yml' & 'crowdin_prep.yml'
   4 In each of those are place holders, which need to be replaced as follows:
   5
   6 <path/to/libretro_core_options.h directory>
   7 -> replace with the path from the root of the repo to the directory containing
   8 'libretro_core_options.h' (it is assumed that 'libretro_core_options.h' &
   9 'libretro_core_options_intl.h' are in the same directory)
  10
  11 <path/to/libretro_core_options.h file>
  12 -> replace with the full path from the root of the repo to the 'libretro_core_options.h' file
  13
  14 <path/to/libretro_core_options_intl.h file>
  15 -> replace with the full path from the root of the repo to the 'libretro_core_options_intl.h' file
  16
  17
  18 From the root of the repo run (using bash):
  19 python3 intl/core_opt_translation.py '<path/to/libretro_core_options.h directory>'
  20
  21 (If python3 doesn't work, try just python)
  22
  23 Push changes to repo. Once merged, request Crowdin integration.
  24
  25
  26 Crowdin integration:
  27
  28 On the project page, go to the Applications tab. Choose GitHub.
  29 There are two options: connecting a GitHub account, which has write/commit permissions to the repo
  30 or providing a GitHub token, which will unlock these permissions.
  31
  32 Then add a repository, a new interface opens. Pick the repository as well as the branch, which you want to sync.
  33 On the right, Crowdin will display the default name of the repository it will use for creating PRs.
  34 Below, set the sync schedule and then save. With that the synchronisation should be set up.
  35 If there are still problems, you might need to manually modify the configuration (double click on the branch in the lower frame).
  36
  37 Here's what the file paths should look like (the '/' at the start is very important!):
  38
  39 Source files path:
  40 /intl/_us/*.json
  41
  42 Translated files path:
  43 /intl/_%two_letters_code%/%original_file_name%
  44
  45
  46 Once Crowdin successfully creates the PR & it has been merged, the automatically created branch can be deleted on GitHub.
  47