]> git.armaanb.net Git - lightcards-http.git/blob - index.html
Add installation instructions
[lightcards-http.git] / index.html
1 <!DOCTYPE html>
2 <html lang="en">
3   <head>
4     <meta charset="utf-8">
5     <meta name="viewport" content="width=device-width">
6     <meta name="description" content="lightcards - terminal flashcards program homepage">
7     <meta name="robots" content="index, follow">
8     <meta http-equiv="Content-Security-Policy" content="default-src 'none'; connect-src 'self'; img-src data: 'self'; style-src 'unsafe-inline';">
9     <meta name="referrer" content="no-referrer">
10     <title>lightcards</title>
11     <style>
12 body {
13   margin: 1em auto;
14   max-width: 650px;
15   line-height: 1.6;
16   padding: 0 10px;
17   font-size: 18px;
18   font-family: serif;
19 }
20
21 h1 {
22   line-height: 0.75;
23 }
24
25 h2 {
26   line-height: 1;
27 }
28
29 img {
30   width: 100%;
31   filter: drop-shadow(0 0 0.5em);
32   margin: 0.5em 0;
33 }
34
35 a {
36   font-size: 1.1em;
37   color: black;
38 }
39     </style>
40     <link href=data:, rel=icon>
41   </head>
42   <body>
43     <header>
44       <hr>
45       <h1>lightcards</h1>
46       <nav>
47         <a href="https://sr.ht/~armaan/lightcards">Source code</a> | 
48         <a href="https://lists.sr.ht/~armaan/public-inbox">Mailing list</a> | 
49         <a href="https://pypi.org/project/lightcards">PyPI</a>
50         <hr>
51         <p>A terminal flashcards program that gets its data from Markdown.</p>
52       </nav>
53     </header>
54
55     <section>
56       <h2>Installation</h2>
57       <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>
58
59       <h3>From PyPI</h3>
60       <code>pip install lightcards</code>
61
62       <h3>From Git</h3>
63       <h4>Main branch (stable)</h4>
64       <code>pip install git+https://git.sr.ht/~armaan/lightcards</code>
65
66       <h4>Development branch</h4>
67       <code>pip install git+https://git.sr.ht/~armaan/lightcards@devel</code>
68     </section>
69
70     <section>
71       <h2>Manpages</h2>
72       <ul>
73         <li><a href="lightcards.1">lightcards(1)</a></li>
74         <li><a href="lightcards-config.5">lightcards-config(5)</a></li>
75       </ul>
76     </section>
77
78     <section>
79       <h2>Gallery</h2>
80       <a href="1.webp">
81         <img src="1.webp" alt="screenshot 1">
82       </a>
83       <a href="2.webp">
84         <img src="2.webp" alt="screenshot 2">
85       </a>
86       <a href="3.webp">
87         <img src="3.webp" alt="screenshot 3">
88       </a>
89     </section>
90
91     <section>
92       <h2>Copyright</h2>
93       <p>Copyright 2021 Armaan Bhojwani, MIT license.
94       <hr>
95     </section>
96   </body>
97 </html>