|
1 | 1 | [](https://hackage.haskell.org/package/hmp3-ng) |
2 | 2 |  |
3 | 3 |
|
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. |
5 | 6 |
|
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. |
11 | 42 |
|
12 | 43 | The original Darcs repo has vanished from the Internet. However, I |
13 | 44 | have a copy I checked out in 2008 (to hack on!) with all the patches |
@@ -54,37 +85,6 @@ preference. |
54 | 85 |
|
55 | 86 | This is still a work in progress. Let me know if there are problems. |
56 | 87 |
|
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 | | - |
88 | 88 | ## Original authorship |
89 | 89 |
|
90 | 90 | ``` |
|
0 commit comments