summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars-Dominik Braun <lars@6xq.net>2021-09-26 10:00:01 +0200
committerLars-Dominik Braun <lars@6xq.net>2021-09-26 10:00:01 +0200
commit286d607fb090be8c0c141b2da16af867a012cba6 (patch)
tree8c7e7ad341dee468c2425a559fc4f3ef9c089d6d
parentb14c9d6b907ad147d02e9de536e4d396e47af03e (diff)
downloadpianobar-286d607fb090be8c0c141b2da16af867a012cba6.tar.gz
pianobar-286d607fb090be8c0c141b2da16af867a012cba6.tar.bz2
pianobar-286d607fb090be8c0c141b2da16af867a012cba6.zip
README: Merge homepage and old README
-rw-r--r--README.md23
-rw-r--r--README.rst212
2 files changed, 212 insertions, 23 deletions
diff --git a/README.md b/README.md
deleted file mode 100644
index 971228e..0000000
--- a/README.md
+++ /dev/null
@@ -1,23 +0,0 @@
-# pianobar
-
-![build](https://github.com/PromyLOPh/pianobar/workflows/build/badge.svg)
-
-pianobar is a console client for the personalized web radio [Pandora](https://www.pandora.com).
-
-### Features
-
-* Play and manage (create, add more music, delete, rename, ...) your stations.
-* Rate played songs and let pandora explain why they have been selected.
-* Show upcoming songs/song history.
-* Configure keybindings.
-* last.fm scrobbling support (external application)
-* Proxy support for listeners outside the USA.
-
-### Source Code
-
-The source code can be downloaded at [github.com](https://github.com/PromyLOPh/pianobar)
-or [6xq.net](https://6xq.net/pianobar/).
-
-### Download/Installation
-
-There are community provided packages available for most Linux distributions (see your distribution’s package manager), macOS ([MacPorts](https://www.macports.org) or [Homebrew](https://brew.sh)) and *BSD as well as a [native Windows port](https://github.com/thedmd/pianobar-windows).
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..c2483d0
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,212 @@
+pianobar
+========
+
+pianobar is a free/open-source, console-based client for the personalized
+online radio Pandora_.
+
+.. _Pandora: http://www.pandora.com
+
+.. image:: https://6xq.net/pianobar/pianobar-screenshot.png
+ :target: https://6xq.net/pianobar/pianobar-screenshot.png
+ :alt: pianobar screenshot
+
+Features
+--------
+
+- play and manage (create, add more music, delete, rename, ...) stations
+- rate songs and explain why they have been selected
+- upcoming songs/song history
+- customize keybindings and text output
+- remote control and eventcmd interface (send tracks to last.fm_, for example)
+- proxy support for listeners outside the USA
+
+.. _last.fm: https://www.last.fm
+
+Download
+--------
+
+There are community provided packages available for most Linux distributions
+(see your distribution’s package manager), Mac OS X (via homebrew_)
+and \*BSD as well as a `native Windows port`_.
+
+.. _homebrew: http://brew.sh/
+.. _native Windows Port: https://github.com/thedmd/pianobar-windows
+
+The current pianobar release is 2020.11.28_ (sha256__, sign__). More recent and
+experimental code is available at GitHub_ and the local gitweb_. Older releases
+are available here:
+
+- 2020.04.05_ (sha256__, sign__)
+- 2019.02.14_ (sha256__, sign__)
+- 2019.01.25_ (sha256__, sign__)
+- 2018.06.22_ (sha256__, sign__)
+- 2017.08.30_ (sha256__, sign__)
+- 2016.06.02_ (sha256__, sign__)
+- 2015.11.22_ (sha256__, sign__)
+- 2014.09.28_ (sha256__, sign__)
+- 2014.06.08_ (sha256__, sign__)
+- 2013.09.15_ (sha256__, sign__)
+- 2013.05.19_ (sha256__, sign__)
+- 2012.12.01_ (sha256__, sign__)
+- 2012.09.07_ (sha256__, sign__)
+- 2012.06.24_ (sha256__, sign__)
+- 2012.05.06_ (sha256__, sign__)
+- 2012.04.24_ (sha256__, sign__)
+- 2012.01.10_ (sha256__, sign__)
+- 2011.12.11_ (sha256__, sign__)
+- 2011.11.11_ (sha256__, sign__)
+- 2011.11.09_ (sha256__, sign__)
+- 2011.09.22_ (sha256__, sign__)
+- 2011.07.09_ (sha256__, sign__)
+- 2011.04.27_ (sha256__, sign__)
+- 2011.04.10_ (sha256__, sign__)
+- 2011.01.24_ (sha256__)
+- 2010.11.06_ (sha1__)
+- 2010.10.07_ (sha1__)
+- 2010.08.21_ (sha1__)
+
+.. _2020.11.28: https://6xq.net/pianobar/pianobar-2020.11.28.tar.bz2
+__ https://6xq.net/pianobar/pianobar-2020.11.28.tar.bz2.sha256
+__ https://6xq.net/pianobar/pianobar-2020.11.28.tar.bz2.asc
+.. _snapshot: http://github.com/PromyLOPh/pianobar/tarball/master
+.. _GitHub: http://github.com/PromyLOPh/pianobar/
+.. _gitweb: https://6xq.net/pianobar/git/
+.. _2020.04.05: https://6xq.net/pianobar/pianobar-2020.04.05.tar.bz2
+__ https://6xq.net/pianobar/pianobar-2020.04.05.tar.bz2.sha256
+__ https://6xq.net/pianobar/pianobar-2020.04.05.tar.bz2.asc
+.. _2019.02.14: https://6xq.net/pianobar/pianobar-2019.02.14.tar.bz2
+__ https://6xq.net/pianobar/pianobar-2019.02.14.tar.bz2.sha256
+__ https://6xq.net/pianobar/pianobar-2019.02.14.tar.bz2.asc
+.. _2019.01.25: https://6xq.net/pianobar/pianobar-2019.01.25.tar.bz2
+__ https://6xq.net/pianobar/pianobar-2019.01.25.tar.bz2.sha256
+__ https://6xq.net/pianobar/pianobar-2019.01.25.tar.bz2.asc
+.. _2018.06.22: https://6xq.net/pianobar/pianobar-2018.06.22.tar.bz2
+__ https://6xq.net/pianobar/pianobar-2018.06.22.tar.bz2.sha256
+__ https://6xq.net/pianobar/pianobar-2018.06.22.tar.bz2.asc
+.. _2017.08.30: https://6xq.net/pianobar/pianobar-2017.08.30.tar.bz2
+__ https://6xq.net/pianobar/pianobar-2017.08.30.tar.bz2.sha256
+__ https://6xq.net/pianobar/pianobar-2017.08.30.tar.bz2.asc
+.. _2016.06.02: https://6xq.net/pianobar/pianobar-2016.06.02.tar.bz2
+__ https://6xq.net/pianobar/pianobar-2016.06.02.tar.bz2.sha256
+__ https://6xq.net/pianobar/pianobar-2016.06.02.tar.bz2.asc
+.. _2015.11.22: https://6xq.net/pianobar/pianobar-2015.11.22.tar.bz2
+__ https://6xq.net/pianobar/pianobar-2015.11.22.tar.bz2.sha256
+__ https://6xq.net/pianobar/pianobar-2015.11.22.tar.bz2.asc
+.. _2014.09.28: https://6xq.net/pianobar/pianobar-2014.09.28.tar.bz2
+__ https://6xq.net/pianobar/pianobar-2014.09.28.tar.bz2.sha256
+__ https://6xq.net/pianobar/pianobar-2014.09.28.tar.bz2.asc
+.. _2014.06.08: https://6xq.net/pianobar/pianobar-2014.06.08.tar.bz2
+__ https://6xq.net/pianobar/pianobar-2014.06.08.tar.bz2.sha256
+__ https://6xq.net/pianobar/pianobar-2014.06.08.tar.bz2.asc
+.. _2013.09.15: https://6xq.net/pianobar/pianobar-2013.09.15.tar.bz2
+__ https://6xq.net/pianobar/pianobar-2013.09.15.tar.bz2.sha256
+__ https://6xq.net/pianobar/pianobar-2013.09.15.tar.bz2.asc
+.. _2013.05.19: https://6xq.net/pianobar/pianobar-2013.05.19.tar.bz2
+__ https://6xq.net/pianobar/pianobar-2013.05.19.tar.bz2.sha256
+__ https://6xq.net/pianobar/pianobar-2013.05.19.tar.bz2.asc
+.. _2012.12.01: https://6xq.net/pianobar/pianobar-2012.12.01.tar.bz2
+__ https://6xq.net/pianobar/pianobar-2012.12.01.tar.bz2.sha256
+__ https://6xq.net/pianobar/pianobar-2012.12.01.tar.bz2.asc
+.. _2012.09.07: https://6xq.net/pianobar/pianobar-2012.09.07.tar.bz2
+__ https://6xq.net/pianobar/pianobar-2012.09.07.tar.bz2.sha256
+__ https://6xq.net/pianobar/pianobar-2012.09.07.tar.bz2.asc
+.. _2012.06.24: https://6xq.net/pianobar/pianobar-2012.06.24.tar.bz2
+__ https://6xq.net/pianobar/pianobar-2012.06.24.tar.bz2.sha256
+__ https://6xq.net/pianobar/pianobar-2012.06.24.tar.bz2.asc
+.. _2012.05.06: https://6xq.net/pianobar/pianobar-2012.05.06.tar.bz2
+__ https://6xq.net/pianobar/pianobar-2012.05.06.tar.bz2.sha256
+__ https://6xq.net/pianobar/pianobar-2012.05.06.tar.bz2.asc
+.. _2012.04.24: https://6xq.net/pianobar/pianobar-2012.04.24.tar.bz2
+__ https://6xq.net/pianobar/pianobar-2012.04.24.tar.bz2.sha256
+__ https://6xq.net/pianobar/pianobar-2012.04.24.tar.bz2.asc
+.. _2012.01.10: https://6xq.net/pianobar/pianobar-2012.01.10.tar.bz2
+__ https://6xq.net/pianobar/pianobar-2012.01.10.tar.bz2.sha256
+__ https://6xq.net/pianobar/pianobar-2012.01.10.tar.bz2.asc
+.. _2011.12.11: https://6xq.net/pianobar/pianobar-2011.12.11.tar.bz2
+__ https://6xq.net/pianobar/pianobar-2011.12.11.tar.bz2.sha256
+__ https://6xq.net/pianobar/pianobar-2011.12.11.tar.bz2.asc
+.. _2011.11.11: https://6xq.net/pianobar/pianobar-2011.11.11.tar.bz2
+__ https://6xq.net/pianobar/pianobar-2011.11.11.tar.bz2.sha256
+__ https://6xq.net/pianobar/pianobar-2011.11.11.tar.bz2.asc
+.. _2011.11.09: https://6xq.net/pianobar/pianobar-2011.11.09.tar.bz2
+__ https://6xq.net/pianobar/pianobar-2011.11.09.tar.bz2.sha256
+__ https://6xq.net/pianobar/pianobar-2011.11.09.tar.bz2.asc
+.. _2011.09.22: https://6xq.net/pianobar/pianobar-2011.09.22.tar.bz2
+__ https://6xq.net/pianobar/pianobar-2011.09.22.tar.bz2.sha256
+__ https://6xq.net/pianobar/pianobar-2011.09.22.tar.bz2.asc
+.. _2011.07.09: https://6xq.net/pianobar/pianobar-2011.07.09.tar.bz2
+__ https://6xq.net/pianobar/pianobar-2011.07.09.tar.bz2.sha256
+__ https://6xq.net/pianobar/pianobar-2011.07.09.tar.bz2.asc
+.. _2011.04.27: https://6xq.net/pianobar/pianobar-2011.04.27.tar.bz2
+__ https://6xq.net/pianobar/pianobar-2011.04.27.tar.bz2.sha256
+__ https://6xq.net/pianobar/pianobar-2011.04.27.tar.bz2.asc
+.. _2011.04.10: https://6xq.net/pianobar/pianobar-2011.04.10.tar.bz2
+__ https://6xq.net/pianobar/pianobar-2011.04.10.tar.bz2.sha256
+__ https://6xq.net/pianobar/pianobar-2011.04.10.tar.bz2.asc
+.. _2011.01.24: https://6xq.net/pianobar/pianobar-2011.01.24.tar.bz2
+__ https://6xq.net/pianobar/pianobar-2011.01.24.tar.bz2.sha256
+.. _2010.11.06: https://6xq.net/pianobar/pianobar-2010.11.06.tar.bz2
+__ https://6xq.net/pianobar/pianobar-2010.11.06.tar.bz2.sha1
+.. _2010.10.07: https://6xq.net/pianobar/pianobar-2010.10.07.tar.bz2
+__ https://6xq.net/pianobar/pianobar-2010.10.07.tar.bz2.sha1
+.. _2010.08.21: https://6xq.net/pianobar/pianobar-2010.08.21.tar.bz2
+__ https://6xq.net/pianobar/pianobar-2010.08.21.tar.bz2.sha1
+
+FAQ
+---
+
+The audio output does not work as expected. What can I do?
+ pianobar uses libao and most problems are related to a broken libao
+ configuration. Have a look at issue `#167`_ for example.
+Can I donate money? Do you have a Flattr/Bitcoin/… account?
+ No, money is not necessary to continue working on pianobar. There are many
+ other ways to support pianobar: Reporting bugs, creating `cool stuff`_
+ based on pianobar, blogging about it and the most important one: Keeping
+ Pandora alive.
+
+.. _#167: https://github.com/PromyLOPh/pianobar/issues/167
+.. _cool stuff: `addons`_
+
+External projects
+-----------------
+
+Addons
+++++++
+
+control-pianobar_
+ Scripts that interact with pianobar entirely through notification bubbles
+ and hotkeys
+pianobar.el_
+ Emacs interface for pianobar
+`pianobar-mediaplayer2`_
+ Control pianobar like any other media player through DBUS/MPRIS.
+
+.. _control-pianobar: http://malabarba.github.io/control-pianobar/
+.. _pianobar.el: https://github.com/agrif/pianobar.el
+.. _pianobar-mediaplayer2: https://github.com/ryanswilson59/pianobar-mediaplayer2
+
+Clients
++++++++
+
+pithos_
+ Python/GTK desktop client
+pianod_
+ Pandora UNIX daemon, based on pianobar
+Hermes_
+ Pandora Client for OS X
+
+.. _pithos: http://pithos.github.io/
+.. _pianod: http://deviousfish.com/pianod/
+.. _Hermes: http://hermesapp.org/
+
+Standalone devices
+++++++++++++++++++
+
+PandoraBar_
+ Beagleboard-based radio device running pianobar
+`Pandora’s Box`_
+ Raspberry Pi-based standalone devices running pianobar
+
+.. _PandoraBar: https://hackaday.com/2012/09/20/how-to-build-your-own-dedicated-pandora-radio/
+.. _Pandora’s Box: http://www.instructables.com/id/Pandoras-Box-An-Internet-Radio-player-made-with/
+