summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorgregory guy <gregory-tde@laposte.net>2020-03-05 15:39:33 +0100
committerSlávek Banko <slavek.banko@axis.cz>2020-03-07 19:45:19 +0100
commitea43b8878719cf4d67201e724c9978078cf9cc29 (patch)
treeb70705da7912b66d52c146c08ca830442d815bb4 /README
parent0cba7b2786b6e96b95aec732dc22b509cd92727c (diff)
downloadakode-ea43b8878719cf4d67201e724c9978078cf9cc29.tar.gz
akode-ea43b8878719cf4d67201e724c9978078cf9cc29.zip
Cleanup the CMakeLists.txt file.
Provide basic cmake build instructions. Write the README file. Delete empty file NEWS. Signed-off-by: gregory guy <gregory-tde@laposte.net> (cherry picked from commit 644ea12784290be3d8a71a3b60de2706983dc9c2)
Diffstat (limited to 'README')
-rw-r--r--README28
1 files changed, 28 insertions, 0 deletions
diff --git a/README b/README
index 8b13789..80f0300 100644
--- a/README
+++ b/README
@@ -1 +1,29 @@
+akode - an audio library for aRts (tde)
+
+
+aKode is a multithreaded audio library that provides aRts with
+plugins to play a variety of formats:
+
+- Ogg Vorbis
+- Musepack (MPC)
+- FLAC
+- Speex
+- Libmad (MPEG-1 and MPEG-2)
+- Libsamplerate
+
+aKode focuses on performance, which means a big enhancement for users
+runing aRts in non-realtime mode.
+
+
+
+ CONTRIBUTING
+==============
+
+If you wish to contribute to aKode (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