Documentation by YARD 0.8.1
-Alphabetic Index
- - -Namespace Listing A-Z
- - - - -
-
-
-
|
-
Lyricli
-The command line client for lyrics
-This is a quick introduction for Lyricli. Right now it's in really early +stages of development, so it's lacking in a lot of stuff (mainly tests +and documentation) ... But it generally works and here's a tutorial to +see how to get it working.
+ +Installing
+ +-
+
- Clone this Repo +
gem build lyricli.gemspec
+gem install lyricli-0.0.1.gem
+- Voila! +
Usage
+ +Lyricli can be invoked with the command lrc and there are three basic
+ways of using it:
lrc
When you run it without arguments, it will look in the available sources +to try to find a playing song and extract the lyrics.
+ +lrc artist song
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.
+ +Commands
+ +The third way to use it is by passing it one of the following special +commands:
+ +-
+
lrc -lorlrc --list-sourceslists the available sources.
+lrc -eorlrc --enable SOURCEenable a source from the list.
+lrc -dorlrc --disable SOURCEdisable a source from the list.
+lrc -rorlrc --reset SOURCEreset all configuration for a source.
+lrc -vorlrc --versionshow the installed version of lyricli.
+lrc -horlrc --helpdisplay some help
+
Roadmap
+ +There is not much defined right now as a roadmap, but this needs to be +done:
+ +-
+
- Specs for all the components +
- YARD documentation for all the components +
And the first thing I want to work on after that is done is separating +the Lyrics Engines so we can add/remove lyrics engines in a similar way to how +we currently add/remove sources.
+ +Leave Feedback Please!
+ +If you decide to use or hack away at Lyricly, please don't forget to +post any issues you find.
+ +License
+ +Licensed under 3-clause-BSD.
+