X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=README.md;h=a0d74a5d632b182ff49661aa38b675640ba52da8;hb=25e3ada874ea7f277129b8d2e39b675bde340afe;hp=9bc7879b87a73b2caa46a853538a07433b454ac7;hpb=ae89ff9e73baee789bcfa1c914da8e29feb2dc04;p=lightcards.git diff --git a/README.md b/README.md index 9bc7879..a0d74a5 100644 --- a/README.md +++ b/README.md @@ -3,21 +3,26 @@ Terminal flashcards from Markdown. ## Installation ### From PyPI -`pip install lightcards` +``` +pip install lightcards +``` ### From Git +#### Stable version +``` +pip install git+https://git.sr.ht/~armaan/lightcards +``` + +#### Development version ``` -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 .` +pip install git+https://git.sr.ht/~armaan/lightcards@devel ``` ## 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 the first table from a valid Markdown or HTML file. Each row is a card, and the two columns are the front and back. ## License Copyright Armaan Bhojwani 2021, MIT license