]> git.r.bdr.sh - rbdr/lyricli.rb/blobdiff - doc/index.html
git.r.bdr.sh / rbdr / lyricli.rb / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Adds some documentation
[rbdr/lyricli.rb] / doc / index.html
diff --git a/doc/index.html b/doc/index.html
index 7d92f25d516f6258ff91a69ccbdeade825cd3579..87b6d5b70f114dc74b5db652b9087d4787017bde 100644 (file)
--- a/doc/index.html
+++ b/doc/index.html
@@ -2,9 +2,11 @@
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
   "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" />
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
 <title>
 <title>
-  Documentation by YARD 0.8.1
+  File: README
+  
+    &mdash; Documentation by YARD 0.8.2.1
   
 </title>
 
   
 </title>
 
@@ -29,6 +31,9 @@
     <div id="header">
       <div id="menu">
   
     <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 class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
 </div>
@@ -56,141 +61,82 @@
 
     <iframe id="search_frame"></iframe>
 
 
     <iframe id="search_frame"></iframe>
 
-    <div id="content"><h1 class="noborder title">Documentation by YARD 0.8.1</h1>
-<div id="listing">
-  <h1 class="alphaindex">Alphabetic Index</h1>
-  
-<div class="clear"></div>
-<h2>Namespace Listing A-Z</h2>
-
-
-
-
-<table>
-  <tr>
-    <td valign='top' width="33%">
-      
-        
-        <ul id="alpha_A" class="alpha">
-          <li class="letter">A</li>
-          <ul>
-            
-              <li>
-                <span class='object_link'><a href="Lyricli/Sources/Arguments.html" title="Lyricli::Sources::Arguments (class)">Arguments</a></span>
-                
-                  <small>(Lyricli::Sources)</small>
-                
-              </li>
-            
-          </ul>
-        </ul>
-      
-        
-        <ul id="alpha_C" class="alpha">
-          <li class="letter">C</li>
-          <ul>
-            
-              <li>
-                <span class='object_link'><a href="Lyricli/Configuration.html" title="Lyricli::Configuration (class)">Configuration</a></span>
-                
-                  <small>(Lyricli)</small>
-                
-              </li>
-            
-          </ul>
-        </ul>
-      
-        
-        <ul id="alpha_L" class="alpha">
-          <li class="letter">L</li>
-          <ul>
-            
-              <li>
-                <span class='object_link'><a href="Lyricli/Lyricli.html" title="Lyricli::Lyricli (class)">Lyricli</a></span>
-                
-                  <small>(Lyricli)</small>
-                
-              </li>
-            
-              <li>
-                <span class='object_link'><a href="Lyricli.html" title="Lyricli (module)">Lyricli</a></span>
-                
-              </li>
-            
-              <li>
-                <span class='object_link'><a href="Lyricli/LyricsEngine.html" title="Lyricli::LyricsEngine (class)">LyricsEngine</a></span>
-                
-                  <small>(Lyricli)</small>
-                
-              </li>
-            
-          </ul>
-        </ul>
-      
-        
-        <ul id="alpha_R" class="alpha">
-          <li class="letter">R</li>
-          <ul>
-            
-              <li>
-                <span class='object_link'><a href="Lyricli/Sources/Rdio.html" title="Lyricli::Sources::Rdio (class)">Rdio</a></span>
-                
-                  <small>(Lyricli::Sources)</small>
-                
-              </li>
-            
-          </ul>
-        </ul>
-      
-        
-        <ul id="alpha_S" class="alpha">
-          <li class="letter">S</li>
-          <ul>
-            
-              <li>
-                <span class='object_link'><a href="Lyricli/SourceManager.html" title="Lyricli::SourceManager (class)">SourceManager</a></span>
-                
-                  <small>(Lyricli)</small>
-                
-              </li>
-            
-              <li>
-                <span class='object_link'><a href="Lyricli/Sources.html" title="Lyricli::Sources (module)">Sources</a></span>
-                
-                  <small>(Lyricli)</small>
-                
-              </li>
-            
-          </ul>
-        </ul>
-      
-        
-        <ul id="alpha_U" class="alpha">
-          <li class="letter">U</li>
-          <ul>
-            
-              <li>
-                <span class='object_link'><a href="Lyricli/Util.html" title="Lyricli::Util (module)">Util</a></span>
-                
-                  <small>(Lyricli)</small>
-                
-              </li>
-            
-          </ul>
-        </ul>
-      
-    </td>
-  </tr>
-</table>
+    <div id="content"><div id='filecontents'><h1>Lyricli</h1>
 
 
-</div>
+<h2>The command line client for lyrics</h2>
 
 
-</div>
+<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">
 
     <div id="footer">
-  Generated on Fri Oct  5 22:31:14 2012 by
+  Generated on Sat Oct  6 02:05:50 2012 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.1 (ruby-1.9.2).
+  0.8.2.1 (ruby-1.9.2).
 </div>
 
   </body>
 </div>
 
   </body>
Original ruby version of lyricli #cli