]> git.armaanb.net Git - lightcards-http.git/blobdiff - index.html
Add installation instructions
[lightcards-http.git] / index.html
index aed3b9838d2e83d1a3743c29af14dea015cbb350..f826c0d750ead482fe4f143a992c76b742728c79 100644 (file)
@@ -3,14 +3,19 @@
   <head>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width">
+    <meta name="description" content="lightcards - terminal flashcards program homepage">
+    <meta name="robots" content="index, follow">
+    <meta http-equiv="Content-Security-Policy" content="default-src 'none'; connect-src 'self'; img-src data: 'self'; style-src 'unsafe-inline';">
+    <meta name="referrer" content="no-referrer">
     <title>lightcards</title>
     <style>
 body {
-  margin: 40px auto;
+  margin: 1em auto;
   max-width: 650px;
   line-height: 1.6;
-  font-size: 18px;
   padding: 0 10px;
+  font-size: 18px;
+  font-family: serif;
 }
 
 h1 {
@@ -23,6 +28,8 @@ h2 {
 
 img {
   width: 100%;
+  filter: drop-shadow(0 0 0.5em);
+  margin: 0.5em 0;
 }
 
 a {
@@ -33,20 +40,58 @@ a {
     <link href=data:, rel=icon>
   </head>
   <body>
-    <hr>
-    <h1>lightcards</h1>
-    <a href="https://sr.ht/~armaan/lightcards">Source code</a> | 
-    <a href="https://lists.sr.ht/~armaan/public-inbox">Mailing list</a> | 
-    <a href="https://pypi.org/project/lightcards">PyPI</a>
-    <hr>
-    <p>A terminal flashcards program that gets its data from Markdown.</p>
-
-    <h2>Gallery</h2>
-    <img src="1.webp" alt="screenshot 1">
-    <img src="2.webp" alt="screenshot 2">
-
-    <h2>Copyright</h2>
-    <p>Copyright 2021 Armaan Bhojwani, MIT license.
-    <hr>
+    <header>
+      <hr>
+      <h1>lightcards</h1>
+      <nav>
+        <a href="https://sr.ht/~armaan/lightcards">Source code</a> | 
+        <a href="https://lists.sr.ht/~armaan/public-inbox">Mailing list</a> | 
+        <a href="https://pypi.org/project/lightcards">PyPI</a>
+        <hr>
+        <p>A terminal flashcards program that gets its data from Markdown.</p>
+      </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">
+        <img src="1.webp" alt="screenshot 1">
+      </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>
+      <h2>Copyright</h2>
+      <p>Copyright 2021 Armaan Bhojwani, MIT license.
+      <hr>
+    </section>
   </body>
 </html>