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

Update the README file

Author: Kim Tore Jensen
Author date (UTC): 2015-08-28 22:25
Committer: Kim Tore Jensen
Commit date (UTC): 2015-08-28 22:25
Tree: fa1ca2c672a0f42bb884190ced82a908410fe319
Parents: 83ba4473e00fc6822797b3434531d20da35ff4a5
File Lines added Lines deleted
README 0 79
README.md 66 0

File README deleted (index 189ff74..0000000)
1 ###############################
2 README - Practical Music Search
3 ###############################
4
5 Copyright (C) 2006-2015 Kim Tore Jensen <kimtjen@gmail.com>.
6
7 The source code and latest version can be found at Github:
8 <https://github.com/ambientsound/pms>.
9
10 Practical Music Search is a ncurses-based client for MPD. It has a command line
11 interface much like Vim, and supports custom colors, layouts, and key bindings.
12 PMS aims to be accessible and highly configurable.
13
14
15 Table of Contents
16 *************************
17
18 1. Compiling
19 2. Requirements
20 3. Configuration
21 4. Reporting bugs
22
23
24
25 1. Compiling
26 ********************
27
28 From a release tarball, run:
29
30 $ ./configure && make && sudo make install
31
32 From the Git tree, run:
33
34 $ ./rebuild.sh
35
36 See INSTALL file for detailed instructions.
37
38
39 2. Requirements
40 ***********************
41
42 PMS is a client for the Music Player Daemon (http://musicpd.org). You need to
43 have MPD installed and working before using PMS, but not neccessarily on the
44 same machine.
45
46 This client works best with recent MPD versions (>= 0.15.0).
47
48 PMS depends on the following libraries:
49
50 ncurses (>= 5.0)
51 glib2 (>= 2.0)
52 boost_regex (>= 1.36.0) to enable regular expression searches
53
54 On a Debian-based system, you can run:
55
56 $ sudo apt-get install build-essential intltool libncursesw5-dev libglib2.0-dev
57
58
59 3. Configuration
60 ************************
61
62 Consult the man page for configuration options.
63
64 There are example configuration files in the "examples" directory.
65
66 If there is no man page available on your system, you can read the manual page
67 online at <http://pms.sourceforge.net/pms.1.html>.
68
69 Hint: type ':help' from within PMS to show a list of all current keyboard
70 bindings.
71
72
73 4. Reporting bugs
74 *************************
75
76 Please use the bug tracker at this URL:
77
78 http://sourceforge.net/apps/trac/pms
79

File README.md added (mode: 100644) (index 0000000..1c34bb0)
1 # Practical Music Search
2
3 Practical Music Search is a ncurses-based client for MPD. It has a command line
4 interface much like Vim, and supports custom colors, layouts, and key bindings.
5 PMS aims to be accessible and highly configurable.
6
7
8 ## Compiling
9
10 PMS is a client for the [Music Player Daemon](http://musicpd.org). You need to
11 have MPD installed and working before using PMS, but not neccessarily on the
12 same machine.
13
14 The client only works with MPD versions >= 0.15.0.
15
16 You'll need `glib >= 2.0`, `ncurses >= 5.0`, and `libmpdclient >= 2.5` to build
17 PMS. Installing `boost_regex >= 1.36.0` will enable regular expression searches.
18 In addition, if building from Git, you'll need the `intltool` package. On
19 Debian-based systems, you can install them by running:
20
21 ```
22 sudo apt-get install build-essential intltool libncursesw5-dev libglib2.0-dev libmpdclient-dev
23 ```
24
25 To build from a release tarball, run:
26
27 ```
28 ./configure && make
29 ```
30
31 From the Git tree, run:
32
33 ```
34 ./rebuild.sh
35 ```
36
37 Then, you may install PMS by running `sudo make install`.
38
39
40 ## Configuration
41
42 Consult the man page for configuration options.
43
44 There are example configuration files in the `examples` directory.
45
46 Hint: type `:help` from within PMS to show a list of all current keyboard
47 bindings.
48
49
50 ## Bugs, feature requests, etc.
51
52 There are many bugs. Please report them if you discover them.
53
54 Please use the [issue tracker](https://github.com/ambientsound/pms/issues) to
55 report bugs, or send them to the author's e-mail address.
56
57
58 ## Authors
59
60 Copyright (c) 2006-2015 Kim Tore Jensen <kimtjen@gmail.com>.
61
62 * Kim Tore Jensen <<kimtjen@gmail.com>>
63 * Bart Nagel <<bart@tremby.net>>
64
65 The source code and latest version can be found at Github:
66 <https://github.com/ambientsound/pms>.
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