Skip to content

Commit e7b1571

Browse files
README and synopsis rewrite.
1 parent 9a7dbcf commit e7b1571

2 files changed

Lines changed: 38 additions & 38 deletions

File tree

README.md

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,44 @@
11
[![Hackage](https://img.shields.io/hackage/v/hmp3-ng.svg)](https://hackage.haskell.org/package/hmp3-ng)
22
![Build status](https://github.com/galenhuntington/hmp3-ng/actions/workflows/haskell.yml/badge.svg)
33

4-
## hmp3-ng
4+
`hmp3-ng` (installed as `hmp3`) is an mp3 music player that runs in
5+
a text terminal with a curses interface.
56

6-
The original `hmp3` music player, written in Haskell, dates to 2005,
7-
and has a curses interface for use in a text terminal. However,
8-
it has become abandonware: the last update was in June 2008, and
9-
it no longer builds with today’s Haskell and standard libraries.
10-
This repository is an effort to resurrect this software.
7+
## Installation
8+
9+
Either `cabal install` or `stack install` will build a binary.
10+
You will need to have `mpg123` installed, which is free software and
11+
widely available in package managers.
12+
13+
The build depends on the package `hscurses`, which in turn requires
14+
curses dev files. In Ubuntu/Debian, for example, these can be obtained
15+
by installing `libncurses-dev`.
16+
17+
## Use
18+
19+
The `hmp3` executable is invoked with a list of mp3 files or
20+
directories of mp3 files.
21+
22+
```
23+
$ hmp3 ~/Music ~/Downloads/La-La.mp3
24+
```
25+
26+
Once running, `hmp3` is controlled by fairly intuitive key commands.
27+
`h` shows a help menu, and `q` quits. `hmp3 --help` prints a simple
28+
help message with command line options.
29+
30+
A color scheme can be specified by writing out a `Config { .. }`
31+
value in `~/.config/hmp3/style.conf` (or wherever your XDG config is).
32+
See `Style.hs` for the definition. The `l` command hot-reloads this
33+
configuration.
34+
35+
## History
36+
37+
The original `hmp3` music player, written in Haskell, dates to 2005.
38+
However, it has become abandonware: the last update was in June 2008,
39+
and it no longer builds with today’s Haskell and standard libraries.
40+
This repository was a fork in 2019 to resurrect this software.
41+
The code has since been heavily rewritten.
1142

1243
The original Darcs repo has vanished from the Internet. However, I
1344
have a copy I checked out in 2008 (to hack on!) with all the patches
@@ -54,37 +85,6 @@ preference.
5485

5586
This is still a work in progress. Let me know if there are problems.
5687

57-
58-
## Installation
59-
60-
Either `cabal install` or `stack install` will build a binary.
61-
You will need to have `mpg123` installed, which is free software and
62-
widely available in package managers.
63-
64-
The build depends on the package `hscurses`, which in turn requires
65-
curses dev files. In Ubuntu/Debian, for example, these can be obtained
66-
by installing `libncurses-dev`.
67-
68-
69-
## Use
70-
71-
The `hmp3` executable is invoked with a list of mp3 files or
72-
directories of mp3 files.
73-
74-
```
75-
$ hmp3 ~/Music ~/Downloads/La-La.mp3
76-
```
77-
78-
Once running, `hmp3` is controlled by fairly intuitive key commands.
79-
`h` shows a help menu, and `q` quits. `hmp3 -h` prints a simple help
80-
message with command line options.
81-
82-
A color scheme can be specified by writing out a `Config { .. }`
83-
value in `~/.config/hmp3/style.conf` (or wherever your XDG config is).
84-
See `Style.hs` for the definition. The `l` command hot-reloads this
85-
configuration.
86-
87-
8888
## Original authorship
8989

9090
```

hmp3-ng.cabal

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
cabal-version: 3.0
22
name: hmp3-ng
33
version: 2.19.1
4-
synopsis: A 2019 fork of an ncurses mp3 player written in Haskell
4+
synopsis: A TUI mp3 player written in Haskell
55
description:
66
An mp3 player with a curses frontend. Playlists are populated by
77
passing file and directory names on the command line. 'h' displays

0 commit comments

Comments
 (0)