[rbdr/lyricli.rb] / doc / index.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>
  File: README
  
    &mdash; Documentation by YARD 0.8.2.1
  
</title>

  <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />

  <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
  hasFrames = window.top.frames.main ? true : false;
  relpath = '';
  framesUrl = "frames.html#!" + escape(window.location.href);
</script>


  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>

  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>


  </head>
  <body>
    <div id="header">
      <div id="menu">
  
    <a href="_index.html">Index</a> &raquo; 
    <span class="title">File: README</span>
  

  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>

      <div id="search">
  
    <a class="full_list_link" id="class_list_link"
        href="class_list.html">
      Class List
    </a>
  
    <a class="full_list_link" id="method_list_link"
        href="method_list.html">
      Method List
    </a>
  
    <a class="full_list_link" id="file_list_link"
        href="file_list.html">
      File List
    </a>
  
</div>
      <div class="clear"></div>
    </div>

    <iframe id="search_frame"></iframe>

    <div id="content"><div id='filecontents'><h1>Lyricli</h1>

<h2>The command line client for lyrics</h2>

<p>This is a quick introduction for Lyricli. Right now it&#39;s in really early
stages of development, so it&#39;s lacking in a lot of stuff (mainly tests
and documentation) ... But it generally works and here&#39;s a tutorial to
see how to get it working.</p>

<h3>Installing</h3>

<ol>
<li>Clone this Repo</li>
<li><code>gem build lyricli.gemspec</code></li>
<li><code>gem install lyricli-0.0.1.gem</code></li>
<li>Voila!</li>
</ol>

<h3>Usage</h3>

<p>Lyricli can be invoked with the command <code>lrc</code> and there are three basic
ways of using it:</p>

<p><code>lrc</code></p>

<p>When you run it without arguments, it will look in the available sources
to try to find a playing song and extract the lyrics.</p>

<p><code>lrc artist song</code></p>

<p>When you run it with arguments, it will use them to search for the
lyrics. This won&#39;t work if you manually disable the arguments source in
your configuration file.</p>

<h4>Commands</h4>

<p>The third way to use it is by passing it one of the following special
commands:</p>

<ul>
<li><code>lrc -l</code> or <code>lrc --list-sources</code> lists the available sources.</li>
<li><code>lrc -e</code> or <code>lrc --enable SOURCE</code> enable a source from the list.</li>
<li><code>lrc -d</code> or <code>lrc --disable SOURCE</code> disable a source from the list.</li>
<li><code>lrc -r</code> or <code>lrc --reset SOURCE</code> reset all configuration for a source.</li>
<li><code>lrc -v</code> or <code>lrc --version</code> show the installed version of lyricli.</li>
<li><code>lrc -h</code> or <code>lrc --help</code> display some help</li>
</ul>

<h3>Roadmap</h3>

<p>There is not much defined right now as a roadmap, but this needs to be
done:</p>

<ul>
<li>Specs for all the components</li>
<li>YARD documentation for all the components</li>
</ul>

<p>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.</p>

<h3>Leave Feedback Please!</h3>

<p>If you decide to use or hack away at Lyricly, please don&#39;t forget to
post any issues you find.</p>

<h3>License</h3>

<p>Licensed under 3-clause-BSD.</p>
</div></div>

    <div id="footer">
  Generated on Sat Oct  6 03:20:24 2012 by
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  0.8.2.1 (ruby-1.9.2).
</div>

  </body>
</html>
Commit	Line	Data
823e558b BB	1	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
	2	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
	3	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	4	<head>
34d0bf15	5	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
823e558b	6	<title>
34d0bf15 BB	7	File: README
	8
	9	— Documentation by YARD 0.8.2.1
823e558b BB	10
	11	</title>
	12
	13	<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
	14
	15	<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
	16
	17	<script type="text/javascript" charset="utf-8">
	18	hasFrames = window.top.frames.main ? true : false;
	19	relpath = '';
	20	framesUrl = "frames.html#!" + escape(window.location.href);
	21	</script>
	22
	23
	24	<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
	25
	26	<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
	27
	28
	29	</head>
	30	<body>
	31	<div id="header">
	32	<div id="menu">
	33
34d0bf15 BB	34	<a href="_index.html">Index</a> »
	35	<span class="title">File: README</span>
	36
823e558b BB	37
	38	<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
	39	</div>
	40
	41	<div id="search">
	42
	43	<a class="full_list_link" id="class_list_link"
	44	href="class_list.html">
	45	Class List
	46	</a>
	47
	48	<a class="full_list_link" id="method_list_link"
	49	href="method_list.html">
	50	Method List
	51	</a>
	52
	53	<a class="full_list_link" id="file_list_link"
	54	href="file_list.html">
	55	File List
	56	</a>
	57
	58	</div>
	59	<div class="clear"></div>
	60	</div>
	61
	62	<iframe id="search_frame"></iframe>
	63
34d0bf15	64	<div id="content"><div id='filecontents'><h1>Lyricli</h1>
823e558b	65
34d0bf15	66	<h2>The command line client for lyrics</h2>
823e558b	67
34d0bf15 BB	68	<p>This is a quick introduction for Lyricli. Right now it's in really early
	69	stages of development, so it's lacking in a lot of stuff (mainly tests
	70	and documentation) ... But it generally works and here's a tutorial to
	71	see how to get it working.</p>
	72
	73	<h3>Installing</h3>
	74
	75	<ol>
	76	<li>Clone this Repo</li>
	77	<li><code>gem build lyricli.gemspec</code></li>
	78	<li><code>gem install lyricli-0.0.1.gem</code></li>
	79	<li>Voila!</li>
	80	</ol>
	81
	82	<h3>Usage</h3>
	83
	84	<p>Lyricli can be invoked with the command <code>lrc</code> and there are three basic
	85	ways of using it:</p>
	86
	87	<p><code>lrc</code></p>
	88
	89	<p>When you run it without arguments, it will look in the available sources
	90	to try to find a playing song and extract the lyrics.</p>
	91
	92	<p><code>lrc artist song</code></p>
	93
	94	<p>When you run it with arguments, it will use them to search for the
	95	lyrics. This won't work if you manually disable the arguments source in
	96	your configuration file.</p>
	97
	98	<h4>Commands</h4>
	99
	100	<p>The third way to use it is by passing it one of the following special
	101	commands:</p>
	102
	103	<ul>
	104	<li><code>lrc -l</code> or <code>lrc --list-sources</code> lists the available sources.</li>
	105	<li><code>lrc -e</code> or <code>lrc --enable SOURCE</code> enable a source from the list.</li>
	106	<li><code>lrc -d</code> or <code>lrc --disable SOURCE</code> disable a source from the list.</li>
	107	<li><code>lrc -r</code> or <code>lrc --reset SOURCE</code> reset all configuration for a source.</li>
	108	<li><code>lrc -v</code> or <code>lrc --version</code> show the installed version of lyricli.</li>
	109	<li><code>lrc -h</code> or <code>lrc --help</code> display some help</li>
	110	</ul>
	111
	112	<h3>Roadmap</h3>
	113
	114	<p>There is not much defined right now as a roadmap, but this needs to be
	115	done:</p>
	116
	117	<ul>
	118	<li>Specs for all the components</li>
	119	<li>YARD documentation for all the components</li>
	120	</ul>
	121
	122	<p>And the first thing I want to work on after that is done is separating
	123	the Lyrics Engines so we can add/remove lyrics engines in a similar way to how
	124	we currently add/remove sources.</p>
	125
	126	<h3>Leave Feedback Please!</h3>
	127
	128	<p>If you decide to use or hack away at Lyricly, please don't forget to
	129	post any issues you find.</p>
	130
	131	<h3>License</h3>
132
133	<p>Licensed under 3-clause-BSD.</p>
134	</div></div>
823e558b BB	135
823e558b BB	136	<div id="footer">
278e6d0a	137	Generated on Sat Oct 6 03:20:24 2012 by
823e558b	138	<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
34d0bf15	139	0.8.2.1 (ruby-1.9.2).
823e558b BB	140	</div>
	141
	142	</body>
	143	</html>