diff --git a/README.html b/README.html index 6dc2fa3b..89736392 100644 --- a/README.html +++ b/README.html @@ -27,7 +27,7 @@

PyRadio

Command line internet radio player.

-

Ben Dowling - https://github.com/coderholic

+

Ben Dowling - https://github.com/coderholic

Table of contents Top

Requirements Top

Installation Top

-

The best way to install PyRadio is via a distribution package, if one exists (e.g. Arch Linux and derivatives can install pyradio-git from AUR).

+

The best way to install PyRadio is via a distribution package, if one exists (e.g. Arch Linux and derivatives can install pyradio-git from AUR).

In any other case, and since PyRadio is currently not available via pip, you will have to build it from source.

Command line options Top

$ pyradio -h
@@ -194,12 +196,12 @@ 

Global encoding declaration

This would be useful in the case where most of your stations do not use utf-8. Instead of editing the playlist and add the encoding to each and every affected station, you just set it globally.

Finding the right encoding

A valid encoding list can be found at:

-

https://docs.python.org/2.7/library/codecs.html#standard-encodings

+

https://docs.python.org/2.7/library/codecs.html#standard-encodings

replacing 2.7 with specific version: 3.0 up to current python version.

Player detection / selection Top

PyRadio is basically built around the existence of a valid media player it can use. Thus, it will auto detect the existence of its supported players upon its execution.

Currently, it supports MPV, MPlayer and VLC, and it will look for them in that order. If none of them is found, the program will terminate with an error.

-

MPV will be used only when the socat multipurpose relay is also installed.

+

MPV will be used only when the socat multipurpose relay is also installed.

Users can alter this default behavior by using the -u command line option. This option will permit the user either to specify the player to use, or change the detection order.

Example:

pyradio -u vlc
@@ -229,6 +231,12 @@

MPlayer

[pyradio] volstep=1 volume=28
+

Search function Top

+

On any window presenting a list of items (stations, playlists, themes) a search function is available by pressing “/”.

+

The Search Window supports normal and extend editing and in session history.

+

After a search term has been successfully found, next occurrence can be obtained using the “n” key and previous occurrence can be obtained using the “N” key.

+

Note: Python 2 users are confined in typing ASCII characters only.

+

Note: Currently, the search function is available on the stations’ and playlists’ window only.

PyRadio Themes Top

PyRadio comes with 6 preconfigured (hard coded) themes:

    @@ -239,7 +247,12 @@

    PyRadio Themes white_on_black or wob (256 color b&w theme). A theme for dark terminal background settings.
  1. black_on_white or bow (256 color b&w theme). A theme for light terminal background settings.
-

and three 256-color system themes (these are actual files saved in the themes installation directory): 1. brown_by_sng, pink_by_sng and purple_by_sng.

+

Furthermore, three 256-color system themes (these are actual files saved in the themes installation directory) are also available:

+
    +
  1. brown_by_sng
  2. +
  3. pink_by_sng
  4. +
  5. purple_by_sng
  6. +

The visual result of an applied theme greatly depends on the terminal settings (e.g. foreground and background color settings, palette used, number of colors supported, real or pseudo-transparency support, etc.)

Pressing “t” will bring up the Theme selection window, which can be used to activate a theme and set the default one.

Note: Themes that use more colors than those supported by the terminal in use, will not be present in the Theme selection window. Furthermore, if a such at theme is set as default (or requested using the “-t” command line option), PyRadio will silently fall-back to the “dark” theme (or the “light” theme, if the terminal supports 8 colors and default theme is set to “light_16_colors”).

@@ -276,6 +289,15 @@

Cleaning up Debug mode Top

Adding the -d option to the command line will instruct PyRadio to enter Debug mode, which means that it will print debug messages to a file. This file will always reside in the user’s home directory and will be named pyradio.log.

-

In case of a bug or a glitch, please include this file to the issue you will open in github.

+

In case of a bug or a glitch, please include this file to the issue you will open at github.

+

Reporting bugs Top

+

When a bug is found, please do report it by opening an issue at github, as already stated above.

+

In you report you should, at the very least, state your pyradio version, python version and method of installation (built from source, AUR, snap, whatever).

+

It would be really useful to include ~/pyradio.log in your report.

+

To create it, enter the following commands in a terminal:

+
$ rm ~/pyradio.log
+$ pyradio -d
+

Then try to reproduce the bug and exit pyradio.

+

Finally, include the file produced in your report.

diff --git a/README.md b/README.md index 6c825bf4..3bbf7e61 100644 --- a/README.md +++ b/README.md @@ -15,11 +15,13 @@ Ben Dowling - [https://github.com/coderholic](https://github.com/coderholic) * [Specifying stations' encoding](#specifying-stations-encoding) * [Player detection / selection](#player-detection-selection) * [Player default volume level](#player-default-volume-level) +* [Search function](#search-function) * [PyRadio Themes](#pyradio-themes) * [Session Locking](#session-locking) * [Update notification](#update-notification) * [Cleaning up](#cleaning-up) * [Debug mode](#debug-mode) +* [Reporting bugs](#reporting-bugs) ## Requirements @@ -327,6 +329,18 @@ Example: volstep=1 volume=28 +## Search function + +On any window presenting a list of items (stations, playlists, themes) a **search function** is available by pressing "**/**". + +The *Search Window* supports normal and extend editing and in session history. + +After a search term has been successfully found, next occurrence can be obtained using the "**n**" key and previous occurrence can be obtained using the "**N**" key. + +**Note:** **Python 2** users are confined in typing ASCII characters only. + +**Note:** Currently, the **search function** is available on the stations' and playlists' window only. + ## PyRadio Themes **PyRadio** comes with 6 preconfigured (hard coded) themes: @@ -338,7 +352,11 @@ Example: 5. **white_on_black** or **wob** (256 color b&w theme). A theme for dark terminal background settings. 6. **black_on_white** or **bow** (256 color b&w theme). A theme for light terminal background settings. -and three 256-color system themes (these are actual files saved in the **themes** installation directory): 1. **brown_by_sng**, **pink_by_sng** and **purple_by_sng**. +Furthermore, three 256-color system themes (these are actual files saved in the **themes** installation directory) are also available: + +1. **brown_by_sng** +2. **pink_by_sng** +3. **purple_by_sng** The visual result of an applied theme greatly depends on the terminal settings (e.g. foreground and background color settings, palette used, number of colors supported, real or pseudo-transparency support, etc.) @@ -408,4 +426,21 @@ As we see, previous versions still exist in this system: **0.7.6.2** and **0.7.7 Adding the ***-d*** option to the command line will instruct **PyRadio** to enter *Debug mode*, which means that it will print debug messages to a file. This file will always reside in the user's home directory and will be named *pyradio.log*. -In case of a bug or a glitch, please include this file to the issue you will [open in github](https://github.com/coderholic/pyradio/issues). +In case of a bug or a glitch, please include this file to the issue you will [open at github](https://github.com/coderholic/pyradio/issues). + +## Reporting bugs + +When a bug is found, please do report it by [opening an issue at github](https://github.com/coderholic/pyradio/issues), as already stated above. + +In you report you should, at the very least, state your **pyradio version**, **python version** and **method** of installation (built from source, AUR, snap, whatever). + +It would be really useful to include **~/pyradio.log** in your report. + +To create it, enter the following commands in a terminal: + + $ rm ~/pyradio.log + $ pyradio -d + +Then try to reproduce the bug and exit **pyradio**. + +Finally, include the file produced in your report. diff --git a/build.html b/build.html index b35eb697..0c554dd2 100644 --- a/build.html +++ b/build.html @@ -27,7 +27,7 @@

Building PyRadio from source

Command line internet radio player.

-

Ben Dowling - https://github.com/coderholic

+

Ben Dowling - https://github.com/coderholic

Table of contents Top