git.r.bdr.sh / rbdr / lyricli.rb / blame
| Commit | Line | Data |
|---|---|---|
| 1be0eee3 BB |
1 | # Lyricli # |
| 2 | ## The command line client for lyrics ## | |
| 3 | ||
| 4 | This is a quick introduction for Lyricli. Right now it's in really early | |
| 5 | stages of development, so it's lacking in a lot of stuff (mainly tests | |
| 6 | and documentation) ... But it generally works and here's a tutorial to | |
| 7 | see how to get it working. | |
| 8 | ||
| 9 | ### Installing ### | |
| 10 | ||
| 11 | 1. Clone this Repo | |
| 12 | 2. `gem build lyricli.gemspec` | |
| 13 | 3. `gem install lyricli-0.0.1.gem` | |
| 14 | 4. Voila! | |
| 15 | ||
| 16 | ### Usage ### | |
| 17 | ||
| 18 | Lyricli can be invoked with the command `lrc` and there are three basic | |
| 19 | ways of using it: | |
| 20 | ||
| 21 | `lrc` | |
| 22 | ||
| 23 | When you run it without arguments, it will look in the available sources | |
| 24 | to try to find a playing song and extract the lyrics. | |
| 25 | ||
| 26 | `lrc artist song` | |
| 27 | ||
| 28 | When you run it with arguments, it will use them to search for the | |
| 29 | lyrics. This won't work if you manually disable the arguments source in | |
| 30 | your configuration file. | |
| 31 | ||
| 32 | #### Commands #### | |
| 33 | ||
| 34 | The third way to use it is by passing it one of the following special | |
| 35 | commands: | |
| 36 | ||
| 37 | * `lrc -l` or `lrc --list-sources` lists the available sources. | |
| 38 | * `lrc -e` or `lrc --enable SOURCE` enable a source from the list. | |
| 39 | * `lrc -d` or `lrc --disable SOURCE` disable a source from the list. | |
| 40 | * `lrc -r` or `lrc --reset SOURCE` reset all configuration for a source. | |
| 41 | * `lrc -v` or `lrc --version` show the installed version of lyricli. | |
| 42 | * `lrc -h` or `lrc --help` display some help | |
| 43 | ||
| 44 | ### Roadmap ### | |
| 45 | ||
| 46 | There is not much defined right now as a roadmap, but this needs to be | |
| 47 | done: | |
| 48 | ||
| 49 | * Specs for all the components | |
| 50 | * YARD documentation for all the components | |
| 51 | ||
| 52 | And the first thing I want to work on after that is done is separating | |
| 53 | the Lyrics Engines so we can add/remove lyrics engines in a similar way to how | |
| 54 | we currently add/remove sources. | |
| 55 | ||
| 32550121 BB |
56 | Also, I want to add the last song to the configuration, so you can check |
| 57 | that. This would let us "watch" lyricli without hammering the lyrics | |
| 58 | wiki api | |
| 59 | ||
| 1be0eee3 BB |
60 | ### Leave Feedback Please! ### |
| 61 | ||
| 62 | If you decide to use or hack away at Lyricly, please don't forget to | |
| 63 | post any issues you find. | |
| 64 | ||
| 65 | ### License ### | |
| 66 | Licensed under 3-clause-BSD. |