Change README to markdown format.r14.0.11

Add translation status overview.

Signed-off-by: Slávek Banko <[email protected]>
(cherry picked from commit 3991a8ece1f610d2651e1b18b2114abb373500fd)

1 files changed, 89 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7c8eb34
--- /dev/null
+++ b/README.md
@@ -0,0 +1,89 @@
+
+ kima - a kicker's applet for TDE.
+
+
+This applet monitors various temperature, frequency and fan sources from
+your kicker panel. 
+
+
+Features:
+---------
+
+supported thermal sources:
+- the Linux ACPI Thermal Zone driver. The corresponding kernel module
+  is called thermal.
+- the thermal sources of the Linux ACPI driver for the IBM ThinkPad
+  laptops. The corresponding kernel module is called ibm-acpi.
+- the IBM Hard Drive Active Protection System (HDAPS) driver.
+  The corresponding kernel module is called hdaps.
+- the Omnibook Configuration Tools & Patches.
+  The corresponding kernel module is called omnibook.
+- the iBook G4 CPU and GPU thermal zones.
+- the thermal sensors available through hwmon (I2C, lm_sensors, ...).
+- the CPU thermal sensor of the i8k kernel driver for Dell Inspiron and
+  Latitude notebooks.
+- the GPU thermal sensors of nvidia-settings.
+  (provided by the nVidia GPU card driver tools, see  FAQ notes below)
+- the termal sensors provided by hddtemp daemon.
+
+
+supported frequency sources:
+- the Linux kernel /proc/cpuinfo interface
+- the Linux kernel cpufreq subsystem
+
+
+supported fan sources:
+- the fan sensors available through hwmon (I2C, lm_sensors, ...).
+- the fan sources of the Linux ACPI driver for the IBM ThinkPad laptops.
+  The corresponding kernel module is called ibm-acpi.
+- the fan sources of the i8k kernel driver for Dell Inspiron and
+  Latitude notebooks.
+
+
+misc sources:
+- battery source that displays the state of charge of your batteries
+  through libhal.
+- uptime source that displays the current system uptime.
+
+
+misc:
+- cpufreqd control module to switch cpufreqd profiles via cpufreqd
+  remote interface.
+
+.
+
+Contributing
+--------------
+
+If you wish to contribute to Kima, you might do so:
+
+- TDE Gitea Workspace (TGW) collaboration tool.
+  https://mirror.git.trinitydesktop.org/gitea
+
+- TDE Weblate Translation Workspace (TWTW) collaboration tool.
+  https://mirror.git.trinitydesktop.org/weblate
+
+.
+
+Contributing
+--------------
+
+If you wish to contribute to basket, you might do so:
+
+- TDE Gitea Workspace (TGW) collaboration tool.
+  https://mirror.git.trinitydesktop.org/gitea
+
+- TDE Weblate Translation Workspace (TWTW) collaboration tool.
+  https://mirror.git.trinitydesktop.org/weblate
+
+
+Translations status
+---------------------
+
+### messages
+[![Translations status](https://mirror.git.trinitydesktop.org/weblate/widgets/applications/-/kima/multi-auto.svg
+"Engage in translating")](https://mirror.git.trinitydesktop.org/weblate/projects/applications/kima/)
+
+### desktop files
+[![Translations status](https://mirror.git.trinitydesktop.org/weblate/widgets/applications/-/kima-kimadesktop/multi-auto.svg
+"Engage in translating")](https://mirror.git.trinitydesktop.org/weblate/projects/applications/kima-kimadesktop/)