diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 61 |
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 |