]> git.armaanb.net Git - lightcards-http.git/blobdiff - index.html
Add installation instructions
[lightcards-http.git] / index.html
index 33b7930974ba73a5b09621ee2c2a60574ba2fdc5..f826c0d750ead482fe4f143a992c76b742728c79 100644 (file)
@@ -52,6 +52,29 @@ a {
       </nav>
     </header>
 
+    <section>
+      <h2>Installation</h2>
+      <p>Lightcards is only tested and maintained on Linux. Support for other Unix-like operating systems such as MacOS and the various BSDs is likely, although untested. Lightcards requires Python 3.9.</p>
+
+      <h3>From PyPI</h3>
+      <code>pip install lightcards</code>
+
+      <h3>From Git</h3>
+      <h4>Main branch (stable)</h4>
+      <code>pip install git+https://git.sr.ht/~armaan/lightcards</code>
+
+      <h4>Development branch</h4>
+      <code>pip install git+https://git.sr.ht/~armaan/lightcards@devel</code>
+    </section>
+
+    <section>
+      <h2>Manpages</h2>
+      <ul>
+        <li><a href="lightcards.1">lightcards(1)</a></li>
+        <li><a href="lightcards-config.5">lightcards-config(5)</a></li>
+      </ul>
+    </section>
+
     <section>
       <h2>Gallery</h2>
       <a href="1.webp">