xaizek / pms (License: GPLv3+) (since 2018-12-07)
Older version of Practical Music Search written in C++.
Commit b82a41191e60697a94128c67c4cbf63aad50173e

Additional formatting to README.
Author: Kim Tore Jensen
Author date (UTC): 2012-09-02 12:02
Committer name: Kim Tore Jensen
Committer date (UTC): 2012-09-02 12:02
Parent(s): 58457a4a807c8e10a0b3576be5479c19b1651e9b
Signing key:
Tree: cd5d4bb7ee1b3227168e953dc157f58b45a3ab99
File Lines added Lines deleted
README.md 25 20
File README.md changed (mode: 100644) (index 1874674..59f81d4)
1 1 # PMS # PMS
2 2 ## Practical Music Search ## Practical Music Search
3 3 Practical Music Search is an ncurses-based client for Practical Music Search is an ncurses-based client for
4 [MPD](http://mpd.wikia.com/wiki/Music_Player_Daemon_Wiki). It has a command line
5 interface much like [Vim](http://www.vim.org), and supports custom colors,
4 [MPD](http://mpd.wikia.com/wiki/Music_Player_Daemon_Wiki). It has a command
5 line interface much like [Vim](http://www.vim.org), and supports custom colors,
6 6 layouts, and key bindings. [PMS](https://github.com/ambientsound/pms) aims to layouts, and key bindings. [PMS](https://github.com/ambientsound/pms) aims to
7 7 be accessible and highly configurable. be accessible and highly configurable.
8 8
 
... ... If you are building from Git, you need GNU autoconf and automake.
16 16 ### Dependencies ### Dependencies
17 17 You need to have [MPD](http://mpd.wikia.com/wiki/Music_Player_Daemon_Wiki) You need to have [MPD](http://mpd.wikia.com/wiki/Music_Player_Daemon_Wiki)
18 18 installed and working before using [PMS](https://github.com/ambientsound/pms), installed and working before using [PMS](https://github.com/ambientsound/pms),
19 but not neccessarily on the same machine. This client requires
19 but not neccessarily on the same machine. This client requires
20 20 [MPD](http://mpd.wikia.com/wiki/Music_Player_Daemon_Wiki) >= 0.15.0. [MPD](http://mpd.wikia.com/wiki/Music_Player_Daemon_Wiki) >= 0.15.0.
21 21
22 22 [PMS](https://github.com/ambientsound/pms) depends on the wide version of [PMS](https://github.com/ambientsound/pms) depends on the wide version of
23 ncurses. On Debian systems this package is called libncurses5w-dev.
23 ncurses. On Debian systems this package is called
24 <code>libncurses5w-dev</code>.
24 25
25 26 ### Configuration ### Configuration
26 Your configuration file is ~/.config/pms/pms.conf. A system-wide config
27 file can be put in /etc/xdg/pms/pms.conf.
27 Your configuration file is <code>~/.config/pms/pms.conf</code>. A system-wide
28 config file can be put in <code>/etc/xdg/pms/pms.conf</code>.
28 29
29 Start PMS and type
30 :set
31 for a list of options available, or type
32 :set color
33 for a list of color options.
30 Start PMS and type <code>:set</code> for a list of options available, or type
31 <code>:set color</code> for a list of color options.
34 32
35 33 #### Setting options #### Setting options
36 34 Options can be set with Options can be set with
35
37 36 set option=value set option=value
38 37 set option+=value set option+=value
39 38 set option-=value set option-=value
39
40 40 Boolean options can be set, inverted or unset with Boolean options can be set, inverted or unset with
41
41 42 set option set option
42 43 set nooption set nooption
43 44 set invoption set invoption
44 45 set option! set option!
46
45 47 Option values can be queried with Option values can be queried with
48
46 49 set option? set option?
47 50
48 51 #### Changing colors #### Changing colors
49 Background colors are black, red, green, brown, blue, magenta, cyan and gray.
50 Foreground colors are as background colors, in addition to
51 brightred, brightgreen, yellow, brightblue, brightmagenta, brightcyan, white.
52 Background colors are <code>black, red, green, brown, blue, magenta,
53 cyan</code> and <code>gray</code>. Foreground colors are as background colors,
54 in addition to <code>brightred, brightgreen, yellow, brightblue, brightmagenta,
55 brightcyan, white</code>.
52 56
53 57 Set colors with Set colors with
58
54 59 set color.name=foreground [background] set color.name=foreground [background]
55 60
56 61 ### Copying ### Copying
57 This program is free software: you can redistribute it and/or modify
58 it under the terms of the GNU General Public License as published by
59 the Free Software Foundation, either version 3 of the License, or
60 (at your option) any later version.
62 This program is free software: you can redistribute it and/or modify it under
63 the terms of the GNU General Public License as published by the Free Software
64 Foundation, either version 3 of the License, or (at your option) any later
65 version.
61 66
62 67 See the COPYING file for more information. See the COPYING file for more information.
63 68
64 69 ### Authors ### Authors
65 70 Written by [Kim Tore Jensen](http://www.incendio.no). Copyright (c) 2006-2011. Written by [Kim Tore Jensen](http://www.incendio.no). Copyright (c) 2006-2011.
66 71
67 A big thanks to contributors [Bart Nagel](https://github.com/tremby)
68 and [Murilo Pereira](https://github.com/mpereira).
72 A big thanks to contributors [Bart Nagel](https://github.com/tremby) and
73 [Murilo Pereira](https://github.com/mpereira).
69 74
70 75 <!--- vi: se ft=markdown et ts=4 sts=4 sw=4: --> <!--- vi: se ft=markdown et ts=4 sts=4 sw=4: -->
Hints

Before first commit, do not forget to setup your git environment:
git config --global user.name "your_name_here"
git config --global user.email "your@email_here"

Clone this repository using HTTP(S):
git clone https://code.reversed.top/user/xaizek/pms

Clone this repository using ssh (do not forget to upload a key first):
git clone ssh://rocketgit@code.reversed.top/user/xaizek/pms

You are allowed to anonymously push to this repository.
This means that your pushed commits will automatically be transformed into a pull request:
... clone the repository ...
... make some changes and some commits ...
git push origin master