README

# OSD Lyrics
Show lyrics with your favorite media player.

## Introduction

OSD Lyrics is a lyrics show compatible with various media players. It is not a plugin but a standalone program. OSD Lyrics shows lyrics on your desktop, in the style similar to KaraOK. It also provides another displaying style, in which lyrics scroll from bottom to top. OSD Lyrics can download lyrics from the network automatically.

OSD Lyrics is released under GPL v3. See COPYING for more detail.

## Usage

To use OSD Lyrics, just launch your media player, then launch OSD Lyrics. OSD Lyrics will detect and connect to the media player. 

## Troubleshooting
>Here is a place to register some troubleshooting with the development or with the compilation.

When run the `autogen.sh` script or run command like `autoconf` or `autoreconf -i`:

- if have error with output containing these lines: `syntax error near unexpected token '0.35.0'` and `IT_PROG_INTLTOOL(0.35.0)`,
  try to install *intltool* package.
  On debian like system: `sudo apt-get install intltool`

- if have a problem with a package dependencies, just install the needed package (particulary the development version).

## Contact Us
The official source repository is on Github: http://github.com/osdlyrics/osdlyrics

If there is any feature request, suggestion, or bug, feel free to report them to https://github.com/osdlyrics/osdlyrics/issues

You can contact main maintainer for support and related subjects through: [osdlyrics@gmail.com](mailto:osdlyrics@gmail.com)

## Contributing

 - Help translate: https://translations.launchpad.net/osd-lyrics
 - Patch: https://github.com/osdlyrics/osdlyrics/pulls
 - Bug report: https://github.com/osdlyrics/osdlyrics/issues
 - Any visual design is welcome :)