summaryrefslogtreecommitdiffstats
path: root/kturtle/data/README.data
diff options
context:
space:
mode:
Diffstat (limited to 'kturtle/data/README.data')
-rw-r--r--kturtle/data/README.data27
1 files changed, 27 insertions, 0 deletions
diff --git a/kturtle/data/README.data b/kturtle/data/README.data
new file mode 100644
index 00000000..8bce26c0
--- /dev/null
+++ b/kturtle/data/README.data
@@ -0,0 +1,27 @@
+Dear Reader,
+
+this is your captain speaking...
+
+KTurtle currently has 3 types of 'data' (as we call it), namely:
+- examples (which are *.logo files)
+- logokeyword.*.xml files
+- logohighlightstyle.*.xml files
+
+In this kdeedu/kturtle/data directory we only store the 'en_US' (default) versions of this data.
+This means that here we store:
+- the English logo examples (a, hopefully ever growing, bunch of *.logo files)
+- the definition used to translate these examples in "logokeyword.en_US.xml"
+- and the accompanying highlight style in "logoheighlightstyle.en_US.xml"
+
+The makefile system makes sure every part gets installed to the right place.
+(if you dont believe me see the Makefile.am in this dir)
+
+For the other localizations a dir like this, containing these files for an other language, can be found in the kde-i18n module of kde.
+On kdecvs this is: kde-i18n/*/data/kdeedu/kturtle (for Dutch this would be: kde-i18n/nl/data/kdeedu/kturtle)
+
+If the localization of KTurtle to you favorite language does not exist yet, you might concider making it. In the documentation of KTurtle you can find some pointers on how to start. Also make sure to see the contents of the kdeedu/kturtle/scripts directory since it contains Rafael Beccar's nifty tranlaton perl scripts that can make translating KTurtle human resource friendly. If you face difficulty translating feel free to contact one of the KTrutle developers.
+
+
+Thanks for reading,
+
+Cies Breijs.