@@ -3,21+3,23 @@ Terminal flashcards from Markdown.
## Installation
### From PyPI
## Installation
### From PyPI
-`pip install lightcards`
+```
+pip install lightcards
+```
### From Git
```
git clone https://git.sr.ht/~armaan/lightcards
cd lightcards
### From Git
```
git clone https://git.sr.ht/~armaan/lightcards
cd lightcards
-git checkout $(git tag | tail -n 1) # Don't include to use development version
-`pip install .`
+git checkout $(git tag | tail -n 1) # Dont include to use development version
+pip install .
```
## Usage
```
## Usage
-see `lightcards --help`
+See `lightcards --help` for usage information.
## Input file
## Input file
-See `contrib/example.md` for an example input file
+`contrib/example.md` is an example input file. Lightcards takes any valid Markdown or HTML table. Each row is a card, and each of the first two columns is a side.