blob: e44319a221a85d5dd6fd992bdd4eee9654444261 [file] [log] [blame]
Marco Brohet3e5334a2014-02-28 01:16:37 +01001cm_crowdin_sync.py
2==================
3
4Introduction
5------------
6This script is used to synchronize CyanogenMod's translations with Crowdin's. It automatically creates cm_caf.xml files, containing
7CAF additions that cannot be seperated in CM source, based on the AOSP base file, and removes them after the push. Also, it can handle
8automatic commiting to Git and pushing/downloading to/from Crowdin.
9
10create_cm_caf_xml.py
11--------------------
12This script is used to create the cm_caf.xml files based on CM's and AOSP's resources XML files.
13
14Prerequisites
15-------------
16The Ruby variant of crowdin-cli is required for this to work.
Marco Brohet680098c2014-02-28 01:21:52 +010017
Marco Brohet3e5334a2014-02-28 01:16:37 +010018 \curl -sSL https://get.rvm.io | bash -s stable --ruby
19 source /home/therbom/.rvm/scripts/rvm # Add this to your .bashrc file!
20 rvm all do gem install crowdin-cli
Marco Brohet680098c2014-02-28 01:21:52 +010021
Marco Brohet3e5334a2014-02-28 01:16:37 +010022python-git is used for Git integration.
Marco Brohet680098c2014-02-28 01:21:52 +010023
Marco Brohet3e5334a2014-02-28 01:16:37 +010024 sudo apt-get install python-git
Marco Brohet680098c2014-02-28 01:21:52 +010025
Marco Brohet3e5334a2014-02-28 01:16:37 +010026The script is currently only python2 supported.
27
28Executing
29---------
Marco Brohet680098c2014-02-28 01:21:52 +010030 Go to root of your local copy of CyanogenMod's source code
Marco Brohet3e5334a2014-02-28 01:16:37 +010031 ./cm_crowdin_sync.py