Add installation instructions

[lightcards-http.git] / index.html

diff --git a/index.html b/index.html
index eefef34cc5184cfe3e62733e15c6cc6106614e44..f826c0d750ead482fe4f143a992c76b742728c79 100644 (file)
--- a/index.html
+++ b/index.html
@@ -28,6 +28,8 @@ h2 {
 
 img {
   width: 100%;
+  filter: drop-shadow(0 0 0.5em);
+  margin: 0.5em 0;
 }
 
 a {
@@ -50,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">
@@ -58,6 +83,9 @@ a {
       <a href="2.webp">
         <img src="2.webp" alt="screenshot 2">
       </a>
+      <a href="3.webp">
+        <img src="3.webp" alt="screenshot 3">
+      </a>
     </section>
 
     <section>