[rbdr/lyricli] / README.md

# Lyricli (lrc)

A command line tool to show the lyrics of your current song.

## Usage

Lyricli can be invoked with the command `lrc`. It can be invoked without
arguments, with an artist and song or with a special command:

```
$ lrc [-t]
```

When you run it without arguments, it will look in the available source
to try to find a playing song and extract the lyrics. If you include the
`-t` flag, it will show the song and artist names before the lyrics.

```
$ lrc [-t] <artist_name> <song_name>
```

When you run it with arguments, it will use them to search for the
lyrics. This won't work if you manually disable the arguments source in
your configuration file. If you include the `-t` flag, it will show the
song and artist names before the lyrics.

### Commands

In order to configure

* `lrc -l` or `lrc --list` lists the available sources. Enabled
  sourcess will have a `*`
* `lrc -e` or `lrc --enable <source>` enables a source
* `lrc -d` or `lrc --disable <source>` disables a source
* `lrc -r` or `lrc --reset <source>` resets the configuration for
  a source and disables it.
* `lrc -v` or `lrc --version` prints the version
* `lrc -h` or `lrc --help` display built-in help

## Building

The build has only been tested on OSX using Swift 5.0.1. Building defaults
to the debug configuration.

```
make
```

## Installing from source

Builds lyricli in release configuration and copies the executable as
`lrc` to `/usr/local/bin`

```
make install
```

### Installing to a custom directory

This can be done by overriding the `install_path` variable

```
make install install_path=/opt/bin
```

## Linting and Generating Documentation

We use [swiftlint][swiftlint] to lint, and `make lint` to run it.
We use [jazzy][jazzy] and [SourceKitten][sourcekitten] to document, and
`make document` to generate it.

## Running tests

No tests at the moment 😬... but the makefile is mapped to run the swift
tests.

```
make test
```

[swiftlint]: https://github.com/realm/SwiftLint
[jazzy]: https://github.com/realm/jazzy
[sourcekitten]: https://github.com/jpsim/SourceKitten
Commit	Line	Data
026a2f69	1	# Lyricli (lrc)
bcd37f40	2
255dbbae BB	3	A command line tool to show the lyrics of your current song.
	4
	5	## Usage
	6
	7	Lyricli can be invoked with the command `lrc`. It can be invoked without
	8	arguments, with an artist and song or with a special command:
	9
	10	```
	11	$ lrc [-t]
	12	```
	13
	14	When you run it without arguments, it will look in the available source
	15	to try to find a playing song and extract the lyrics. If you include the
	16	`-t` flag, it will show the song and artist names before the lyrics.
	17
	18	```
	19	$ lrc [-t] <artist_name> <song_name>
	20	```
	21
	22	When you run it with arguments, it will use them to search for the
	23	lyrics. This won't work if you manually disable the arguments source in
	24	your configuration file. If you include the `-t` flag, it will show the
	25	song and artist names before the lyrics.
	26
	27	### Commands
	28
	29	In order to configure
	30
f43cbaf0	31	* `lrc -l` or `lrc --list` lists the available sources. Enabled
255dbbae BB	32	sourcess will have a `*`
	33	* `lrc -e` or `lrc --enable <source>` enables a source
	34	* `lrc -d` or `lrc --disable <source>` disables a source
f43cbaf0	35	* `lrc -r` or `lrc --reset <source>` resets the configuration for
255dbbae BB	36	a source and disables it.
	37	* `lrc -v` or `lrc --version` prints the version
	38	* `lrc -h` or `lrc --help` display built-in help
026a2f69 BB	39
	40	## Building
	41
1a8c14fd	42	The build has only been tested on OSX using Swift 5.0.1. Building defaults
255dbbae BB	43	to the debug configuration.
	44
	45	```
	46	make
	47	```
	48
	49	## Installing from source
	50
	51	Builds lyricli in release configuration and copies the executable as
	52	`lrc` to `/usr/local/bin`
	53
	54	```
	55	make install
	56	```
	57
	58	### Installing to a custom directory
	59
	60	This can be done by overriding the `install_path` variable
	61
	62	```
	63	make install install_path=/opt/bin
	64	```
026a2f69	65
259284d0 BB	66	## Linting and Generating Documentation
	67
	68	We use [swiftlint][swiftlint] to lint, and `make lint` to run it.
	69	We use [jazzy][jazzy] and [SourceKitten][sourcekitten] to document, and
	70	`make document` to generate it.
	71
026a2f69 BB	72	## Running tests
026a2f69 BB	73
255dbbae BB	74	No tests at the moment 😬... but the makefile is mapped to run the swift
	75	tests.
	76
	77	```
	78	make test
	79	```
22172f7d	80
259284d0 BB	81	[swiftlint]: https://github.com/realm/SwiftLint
	82	[jazzy]: https://github.com/realm/jazzy
	83	[sourcekitten]: https://github.com/jpsim/SourceKitten