summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormio <stigma@disroot.org>2024-11-12 11:44:17 +1000
committermio <stigma@disroot.org>2024-11-13 21:12:37 +1000
commitbc96a348f0971bf6a217750e4a3fc4f45c2a309b (patch)
tree271061e5bc662dcda70f81772f46b3e55590ae1e
parent798d8c284c8c712cab5e550c4ddc13a54315b701 (diff)
downloadktorrent-bc96a348f0971bf6a217750e4a3fc4f45c2a309b.tar.gz
ktorrent-bc96a348f0971bf6a217750e4a3fc4f45c2a309b.zip
Convert README to Markdown
Signed-off-by: mio <stigma@disroot.org> (cherry picked from commit 43b8b7f3e82d5bdf5bdd7a2a3b197cd88a0e2a7d)
-rw-r--r--README18
-rw-r--r--README.md32
2 files changed, 32 insertions, 18 deletions
diff --git a/README b/README
deleted file mode 100644
index 099042a..0000000
--- a/README
+++ /dev/null
@@ -1,18 +0,0 @@
-KTorrent - A KDE BitTorrent client
------------------------------------
-
-For installation follow the instructions from INSTALL file, but simple
-
-./configure --prefix=$TDEDIR
-make
-make install (as root)
-
-will install KTorrent hopefully without any problems.
-
-
-For more info please visit
-
-http://www.ktorrent.org/
-
-
-KT Team \ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3846838
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+KTorrent
+========
+
+KTorrent is a BitTorrent client for TDE.
+
+
+Features
+--------
+
+- File prioritization
+- Speed capping
+- Torrent queuing
+- Support for DHT, PeerExchange, UDP Trackers, and Encryption
+- A plugin system for extending KTorrent's builtin features
+
+Contributing
+------------
+
+There are multiple ways of contributing to KTorrent:
+
+- Development using [TDE Gitea Workspace (TGW)](https://mirror.git.trinitydesktop.org/gitea)
+- Translations using [TDE Weblate Translation Workspace (TWTW)](https://mirror.git.trinitydesktop.org/weblate)
+
+General information on contributing to TDE can be found in the [Developers Category on the Trinity Wiki](https://wiki.trinitydesktop.org/Category:Developers).
+
+Translation Status
+------------------
+
+### Messages
+
+[![Message translations status](https://mirror.git.trinitydesktop.org/weblate/widgets/applications/-/ktorrent/multi-auto.svg
+"Engage in translating messages")](https://mirror.git.trinitydesktop.org/weblate/projects/applications/ktorrent/)