summaryrefslogtreecommitdiff
path: root/www/lang/README.md
diff options
context:
space:
mode:
authorpliablepixels <pliablepixels@gmail.com>2016-06-02 15:17:18 -0400
committerpliablepixels <pliablepixels@gmail.com>2016-06-02 15:17:18 -0400
commit578f83f9be9795e16714641ae13909fa4714f37b (patch)
treefce10e24e694ac6b18db9d245546dbd293ce206a /www/lang/README.md
parent29b13a5332eeb3e7003d834b21fa65a4948f18b2 (diff)
#261 - language file sorting, checking for completeness and pretty layout automation
Former-commit-id: 46406e8c93331b9e26da581a0487216f4154cabe
Diffstat (limited to 'www/lang/README.md')
-rw-r--r--www/lang/README.md16
1 files changed, 12 insertions, 4 deletions
diff --git a/www/lang/README.md b/www/lang/README.md
index 9e079acc..a735c0cd 100644
--- a/www/lang/README.md
+++ b/www/lang/README.md
@@ -1,13 +1,21 @@
####Main Language file
* Make sure there is no comma after the last element
* Comments are not allowed
-* Prettify and sort using http://www.uize.com/examples/json-prettifier.html
- * Preset:Padded and Sorted/Key Padding:on, Key Quoting: always, Key Sorting: On
+* After you complete the translation file, do the following:
+
+(replace ``-it`` with the language you are working on)
+``
+./checklang.py -f locale-it.json -b
+``
+This validates your JSON file and if valid, creates pretty-locale-it.json. If you are sure it looks good,
+``
+./checklang.py -f locale-it.json -b -o
+``
+this validates your JSON file and if valid, OVERWRITES your local file with a pretty formatted version, which is what you should PR
+
####Help language file
* Located inside lang/help
* Please be careful not to mess up the html tags, please only focus on text translation
-####Validation
-* After you create your language file, run ``./checklang.py`` inside the lang folder. Its a python script that will ensure that your language keys are complete. \ No newline at end of file