summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMichele Calgaro <michele.calgaro@yahoo.it>2022-06-18 22:59:25 +0900
committerMichele Calgaro <michele.calgaro@yahoo.it>2022-07-10 17:59:48 +0900
commit5161d40d204dc6dbd9c34b5be0052243240f15b1 (patch)
tree5ccc61290c25f3c1f18a1e821ea59f90df97518e /README.md
parente46a8b8db6082f7d5e293407d654f127c48a0256 (diff)
downloadtderadio-5161d40d204dc6dbd9c34b5be0052243240f15b1.tar.gz
tderadio-5161d40d204dc6dbd9c34b5be0052243240f15b1.zip
CMake conversion.
Signed-off-by: Michele Calgaro <michele.calgaro@yahoo.it> Signed-off-by: Slávek Banko <slavek.banko@axis.cz> (cherry picked from commit bc7518bdba609f90ee89de8b4e7ddaa1e567b1a8)
Diffstat (limited to 'README.md')
-rw-r--r--README.md61
1 files changed, 61 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cdbe49e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,61 @@
+
+TDERadio - a comfortable radio application for TDE
+
+
+Requirements
+------------
+- v4l or v4l2 enabled kernel
+- libsndfile (development package or header for compilation, library for execution)
+- libmp3lame (for mp3 encoding)
+- oss support (mixer, dsp/pcm) ??
+- radio card ;)
+
+Configuration files
+---------------------
+
+gui, alarms, etc.:
+ .trinity/share/config/tderadiorc
+
+stations (xml-format):
+ .trinity/share/apps/tderadio/stations.krp
+
+systemwide presets (xml-format):
+ <tdedir>/share/apps/tderadio/presets/<country>/<city>-<media>.krp
+
+
+lirc support
+--------------
+
+lirc support is realized by the lirc_client lib. This library is used to
+translate the remote control key names to names used by tderadio, and may
+additionally be used for state management (tv, etc).
+
+Names used by tderadio:
+
+ TV powerOff, give tv program a chance
+ 0..9 numerical station selection
+ CH+ frequency increment
+ CH- frequency decrement
+ VOL+ volume increment
+ VOL- volume decrement
+ CH-SEARCH beachward station search
+ CH+SEARCH forward statino search
+ POWER power tderadio on/off
+ RADIO power tderadio on
+ SLEEP enable sleep countdown
+ NEXT next station in list
+ PREV prev station in list
+ QUIT quit tderadio application
+
+.
+
+Contributing
+--------------
+
+If you wish to contribute to TDERadio, 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