updated readme

Author: hanneshal

README.md

@@ -4,12 +4,8 @@ If you want to contribute to the Zammad documentation you can edit the rst files
 
 We take care about the translation part, so please don't change anything else whithin the repository. These changes would be discarded anyway ;)
 
-Note:
-At the moment we only have a german version. We are working on an english version and will change the default later.
-
-## Documentation
-
-Zammad hosts a searchable version of this documentation at https://docs.zammad.org
+## Note:
+** Please modify only *.rst files** the *.PO and *.MO files are autogenerated!
 
 ## ReStructuredText markup
 
@@ -52,28 +48,48 @@ brew install gettext
 The workflow itself
 ```
 # create .tx config
+```
 tx init
+```
 # or if you just want to update a ressource
+```
 tx set --source -r <project_slug.resource_slug> -l <lang> <file>
 
 make clean
-
+```
 # this will generate the strings from the *.rst files
+```
 make gettext
-
+```
 # this will generate the locales (DE|EN)
+```
 sphinx-intl update -p _build/locale/ -l de -l en
+```
 
 # this will update the resource files from the pot dir
+```
 sphinx-intl update-txconfig-resources --pot-dir _build/locale --transifex-project-name zammad-user-documentation
+```
 
 # push to transifex (if configured)
+```
 tx push -s
+```
 
 # after translation pull needed languages from transifex
+```
 tx pull -l en
+```
+
+# build the .MO files for use with readthedocs
+
+```
+sh build_mo.sh
+```
+
+After a successful build, push to this repo and readthedocs will update itself.
 
-# manual language-based build (_build/html/)
+# manual language-based build (_build/html/) (for testing)
 make -e SPHINXOPTS="-D language='de'" html
 make -e SPHINXOPTS="-D language='en'" html
 

build_mo.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/sh
 for langfile in `find locale -name "*.po"`
 do
     subdir=`dirname $langfile`