]> git.armaanb.net Git - lightcards.git/commitdiff
Update README
authorArmaan Bhojwani <me@armaanb.net>
Mon, 1 Feb 2021 18:54:54 +0000 (13:54 -0500)
committerArmaan Bhojwani <me@armaanb.net>
Mon, 1 Feb 2021 19:01:00 +0000 (14:01 -0500)
README.md

index 9bc7879b87a73b2caa46a853538a07433b454ac7..93309015ebb659c223b9cc1c4d7bdc06a9158569 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,21 +3,23 @@ Terminal flashcards from Markdown.
 
 ## Installation
 ### From PyPI
-`pip install lightcards`
+```
+pip install 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
-see `lightcards --help`
+See `lightcards --help` for usage information.
 
 ## 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.
 
 ## License
 Copyright Armaan Bhojwani 2021, MIT license