summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md58
1 files changed, 58 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7795839
--- /dev/null
+++ b/README.md
@@ -0,0 +1,58 @@
+
+ KNETLoad - a network throughput meter for Kicker (TDE panel).
+
+
+Knetload is a network throughput meter for Kicker for the TDE panel.
+It will show the traffic on a network device with two diagrams, one for
+outgoing and the other for incoming data. It can read almost any device
+that is listed in the /proc/net/dev file which includes eth0, ppp0,
+ippp0 and many others; even non predefined devices can be typed into the
+program. The colors, the style and the speed the diagrams can be
+configured.
+
+To bring up the settings menu, simply right click on the diagram. Before
+KNetLoad can work you have to define what device it should use and you
+should also set the correct scaling value which depends on the speed of
+your network device.
+
+Left click on the diagram to bring up a small information box which will
+show the exact input and output speeds in text form and the total amount
+of outgoing and incoming data.
+
+.
+
+Contributing
+--------------
+
+If you wish to contribute to Knetload (TDE), 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/-/knetload/multi-auto.svg
+"Engage in translating")](https://mirror.git.trinitydesktop.org/weblate/projects/applications/knetload/)
+
+### desktop files
+[![Translations status](https://mirror.git.trinitydesktop.org/weblate/widgets/applications/-/knetload-knetloaddesktop/multi-auto.svg
+"Engage in translating")](https://mirror.git.trinitydesktop.org/weblate/projects/applications/knetload-knetloaddesktop/)