pnimrp/readme.rst

34 lines
929 B
ReStructuredText

======
pnimrp
======
this is a simple, portable terminal-based radio/music station
player. this project was meant to be a rewrite of pmrp, as a
learning exercise.
.. warning ::
this project is not maintained anymore, it may be unarchived
and remaintained later in fhe future. it is time to move on.
| see doc/user.rst for a basic level user usage documentation.
| see doc/installation.rst for installation instructions.
Note
----
All of the out-of-code Documentation is written in RST, so
these can be viewed in a typical text editor or can be used
to generate HTML source by running::
nim rst2html file.rst
then use a web browser to open htmldocs/file.html
Cites
-----
- pmrp -> https://github.com/hakerdefo/pmrp
code was referenced and links were used.
- libmpv -> https://github.com/mpv-player/mpv
api library was used for playback.
- c2nim -> https://github.com/nim-lang/c2nim
helped wrapping objects.