Commits

Steve Losh  committed 860b1e1

clojure-lanterna: Update site.

  • Participants
  • Parent commits d371ce7

Comments (0)

Files changed (2)

File clojure-lanterna/index.html

                 <div class="markdown">
 <p>clojure-lanterna is a thin wrapper around the <a href="https://code.google.com/p/lanterna/">Lanterna</a> Java library to make
 it more Clojure-friendly.</p>
+<h2 id="what-is-it">What is It?</h2>
 <p><a href="https://code.google.com/p/lanterna/">Lanterna</a> is a Java library for interacting with terminals.  It's kind of
 like curses, except it's pure Java so it'll run anywhere.  It lets you move the
 cursor around, draw colored text, and so on.</p>
 either in the terminal or in a separate Swing window when you don't have
 a real terminal available (inside an IDE or on a certain terrible OS).</p>
 <p>It's particularly nice for writing Roguelikes.</p>
-<p>There are three main layers to Lanterna.  This documentation is for
-clojure-lanterna, but will cover everything you'll need to know, so you probably
-won't need to read Lanterna's docs separately.</p>
-<p>Currently clojure-lanterna supports the first two layers of Lanterna: Terminal
-and Screen.  At some point support may be added for the GUI layer, but not any
-time soon.</p>
-<p>Start at the Installation docs, then read the Terminal docs, then the Screen
-docs.</p><h2>Table of Contents</h2><ol class="toc"><li><a href="installation/">Installation</a></li><li><a href="terminals/">Terminals</a></li><li><a href="screens/">Screens</a></li><li><a href="reference/">Reference</a></li></ol>
+<h2 id="how-to-use-it">How to Use It</h2>
+<p>There are three main layers to Lanterna.  Currently clojure-lanterna supports
+the first two layers of Lanterna: Terminal and Screen.  At some point support
+may be added for the GUI layer, but not any time soon.</p>
+<p>To get started:</p>
+<ol>
+<li>
+<p>Read the <a href="https://code.google.com/p/lanterna/wiki/DevelopmentGuide">first page</a> of the <a href="https://code.google.com/p/lanterna/wiki/DevelopmentGuide">Lanterna
+   documentation</a>.  It sums up some main concepts and things
+   you'll need to watch out for.</p>
+</li>
+<li>
+<p>Come back here and read the <a href="./installation/">Installation</a> docs to get
+   clojure-lanterna on your machine.</p>
+</li>
+<li>
+<p>Read the <a href="./terminals/">Terminal</a> and <a href="./screens/">Screen</a> documents here in
+   order.</p>
+</li>
+<li>
+<p>Have fun!  Consult the <a href="./reference/">Reference</a> document if you need more
+   detailed information about something.  Most functions also have docstrings.</p>
+</li>
+</ol><h2>Table of Contents</h2><ol class="toc"><li><a href="installation/">Installation</a></li><li><a href="terminals/">Terminals</a></li><li><a href="screens/">Screens</a></li><li><a href="reference/">Reference</a></li></ol>
                 </div>
             <footer><p>Created by <a href="http://stevelosh.com">Steve Losh</a>.
 Documentation created with <a href="http://sjl.bitbucket.org/d/">d</a>.</p>

File clojure-lanterna/installation/index.html

         </script></head><body class="content">
         <div class="wrap">
             <header><h1><a href="..">clojure-lanterna</a></h1></header><div class="markdown">
-<h1 id="installation"><a href="">Installation</a></h1><p>Add this to your <code>project.clj</code>:</p>
+<h1 id="installation"><a href="">Installation</a></h1><p>clojure-lanterna requires Leiningen 2 and Clojure 1.4.  It might work with other
+versions, but I make no guarantees.</p>
+<p>It has no other dependencies (aside from Lanterna itself, of course).</p>
+<p>Add this to your <code>project.clj</code>:</p>
 <div class="codehilite"><pre><span class="p">[</span><span class="n">clojure</span><span class="o">-</span><span class="n">lanterna</span> "1<span class="p">.</span>0<span class="p">.</span>0"<span class="p">]</span>
 </pre></div>