git.r.bdr.sh - rbdr/lyricli.rb/blob - README.md

   1 # Lyricli.rb (Deprecated)
   2
   3 The repository is intended only as an archive for the former ruby version of lyricli
   4
   5 ## The command line client for lyrics ##
   6
   7 This is a quick introduction for Lyricli. Right now it's in really early
   8 stages of development, so it's lacking in a lot of stuff (mainly tests
   9 and documentation) ... But it generally works and here's a tutorial to
  10 see how to get it working.
  11
  12 ### Installing ###
  13
  14 `gem install lyricli`
  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 #### It always gives me rdio even if using iTunes ####
  45
  46 Due to the way the rdio API works, we can't tell if you're actively
  47 listen and it always returns the last song. Currently the best way to
  48 have the sources correctly is to enable **rdio first** and then
  49 **itunes**. If you enabled itunes first, you can just disable and
  50 re-enable and it should fix it.
  51
  52 ### Roadmap ###
  53
  54 There is not much defined right now as a roadmap, but this needs to be
  55 done:
  56
  57 * Specs for all the components
  58 * YARD documentation for all the components
  59
  60 And the first thing I want to work on after that is done is separating
  61 the Lyrics Engines so we can add/remove lyrics engines in a similar way to how
  62 we currently add/remove sources.
  63
  64 Also, I want to add the last song to the configuration, so you can check
  65 that. This would let us "watch" lyricli without hammering the lyrics
  66 wiki api
  67
  68 Also, during the enable phase, sources like iTunes should check for
  69 proper OS and stop if they're not in their home turf.
  70
  71 ### Leave Feedback Please! ###
  72
  73 If you decide to use or hack away at Lyricly, please don't forget to
  74 post any issues you find.