cplay-ng

commit

0a33d540bb45de61274be7c68197c968d7bb0528

parent

330d6755addf3cc179512cab5b9ef89ef35f418c

Author

Tobias Bengfort <tobias.bengfort@posteo.de>

Date

2024-08-03 17:48

convert README to markdown

Diffstat

3 files changed, 31 insertions, 40 deletions

diff --git a/README.md b/README.md

@@ -0,0 +1,30 @@
   -1     1 # Description
   -1     2 
   -1     3 `cplay` is a minimalist music player with a textual user interface
   -1     4 written in Python. It aims to provide a power-user-friendly interface
   -1     5 with simple filelist and playlist control.
   -1     6 
   -1     7 Instead of building an elaborate database of your music library, `cplay`
   -1     8 allows you to quickly browse the filesystem and enqueue files,
   -1     9 directories, and playlists.
   -1    10 
   -1    11 The original cplay was started by Ulf Betlehem in 1998 and is no longer
   -1    12 maintained. This is a rewrite that aims to stay true to the original
   -1    13 design while evolving with a shifting environment.
   -1    14 
   -1    15 ![screenshot of cplay with file browser](screenshot.png)
   -1    16 
   -1    17 # Requirements
   -1    18 
   -1    19 -   [python3](http://www.python.org/)
   -1    20 -   [mpv](https://mpv.io/)
   -1    21 
   -1    22 # Installation
   -1    23 
   -1    24     $ pip install cplay-ng
   -1    25 
   -1    26 # Usage
   -1    27 
   -1    28     $ cplay-ng
   -1    29 
   -1    30 Press `h` to get a list of available keys.

diff --git a/README.rst b/README.rst

@@ -1,39 +0,0 @@
    1    -1 Description
    2    -1 -----------
    3    -1 
    4    -1 ``cplay`` is a minimalist music player with a textual user interface
    5    -1 written in Python. It aims to provide a power-user-friendly interface
    6    -1 with simple filelist and playlist control.
    7    -1 
    8    -1 Instead of building an elaborate database of your music library,
    9    -1 ``cplay`` allows you to quickly browse the filesystem and enqueue
   10    -1 files, directories, and playlists.
   11    -1 
   12    -1 The original cplay was started by Ulf Betlehem in 1998 and is no longer
   13    -1 maintained.  This is a rewrite that aims to stay true to the original design
   14    -1 while evolving with a shifting environment.
   15    -1 
   16    -1 .. image:: screenshot.png
   17    -1    :alt: screenshot of cplay with file browser
   18    -1 
   19    -1 Requirements
   20    -1 ------------
   21    -1 
   22    -1 - `python3 <http://www.python.org/>`_
   23    -1 - `mpv <https://mpv.io/>`_
   24    -1 
   25    -1 Installation
   26    -1 ------------
   27    -1 
   28    -1 ::
   29    -1 
   30    -1     $ pip install cplay-ng
   31    -1 
   32    -1 Usage
   33    -1 -----
   34    -1 
   35    -1 ::
   36    -1 
   37    -1     $ cplay-ng
   38    -1 
   39    -1 Press ``h`` to get a list of available keys.

diff --git a/pyproject.toml b/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
    6     6 name = "cplay-ng"
    7     7 version = "5.3.0"
    8     8 description = "A simple curses audio player"
    9    -1 readme = "README.rst"
   -1     9 readme = "README.md"
   10    10 license = {text = "GPLv2+"}
   11    11 keywords = ["music-player", "curses"]
   12    12 authors = [