aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorfilip <filip.komar@gmail.com>2013-11-01 13:35:37 +0100
committerfilip <filip.komar@gmail.com>2013-11-01 13:35:37 +0100
commit7da31ab1ff31830f275abc0eaccdf7427a5d565f (patch)
tree3b4c8308c3c0c2804f7b39cdc30086af275ecb01 /README
parent004b991f5e03c437d5b5ab78d775604a3210c22d (diff)
downloadtools-7da31ab1ff31830f275abc0eaccdf7427a5d565f.tar
tools-7da31ab1ff31830f275abc0eaccdf7427a5d565f.tar.gz
tools-7da31ab1ff31830f275abc0eaccdf7427a5d565f.tar.bz2
tools-7da31ab1ff31830f275abc0eaccdf7427a5d565f.tar.xz
tools-7da31ab1ff31830f275abc0eaccdf7427a5d565f.zip
some improvements in README documentation
Diffstat (limited to 'README')
-rw-r--r--README12
1 files changed, 10 insertions, 2 deletions
diff --git a/README b/README
index 8cdd4dd7..05e3cc06 100644
--- a/README
+++ b/README
@@ -9,7 +9,7 @@ added creation of working copy of po resource
FEATURES
-it's very configurable
--support for git
+-support for git (currently all resources except translations for web pages)
-support for many types of svn checkout: anonymous (default), user or ssh key authentication
-support for doc team resources
-it logs all important actions
@@ -27,7 +27,15 @@ FEATURES
INSTALATION AND CONFIGURATION
-Please put script check_for_translation_work.sh in your home directory ~/bin or create a symlink to it from git directory. That way it will be in your PATH so you can call it from any directory. After first run please adjust file ~/.mageia-i18n-config to suit your needs. Remember to upload your public ssh key to mageia identity! Otherwise the script will prompty you for password everytime for every svn resource and git commit & push will be unavailable to you. See wiki for details how to do that.
+Please put the script check_for_translation_work.sh in your home directory ~/bin or create a symlink to it from git directory and make it executable.
+That way it will be in your PATH so you can call it from any directory. After first run please adjust file ~/.mageia-i18n-config to suit your needs.
+Script will automatically copy or update list of translatable resources if check_updates is set to 1 (default) in config file.
+If you choose to disable update you should manually copy list (translation_projects.dat) to the location of git_directory in config file.
+
+Remember to upload your public ssh key to mageia identity! Otherwise the script will prompty you for password everytime for every svn resource and git commit & push will be unavailable to you.
+See wiki (https://wiki.mageia.org/en/Git_usage_for_l10n_and_doc) for details.
+It's recommended that you first try git clone and push without script to test if your setup is as it should be.
+Same goes for svn commit if you need it (currently there are only translations for web pages left on svn).
At least you need to adjust following setings in configuration file named .mageia-i18n-config that has been made in your home directory on the first run of the script.