X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=README.md;h=a0d74a5d632b182ff49661aa38b675640ba52da8;hb=25e3ada874ea7f277129b8d2e39b675bde340afe;hp=93309015ebb659c223b9cc1c4d7bdc06a9158569;hpb=e29685d1b1476f8c59b4c14563a449d8385b9399;p=lightcards.git diff --git a/README.md b/README.md index 9330901..a0d74a5 100644 --- a/README.md +++ b/README.md @@ -8,18 +8,21 @@ pip install lightcards ``` ### From Git +#### Stable version ``` -git clone https://git.sr.ht/~armaan/lightcards -cd lightcards -git checkout $(git tag | tail -n 1) # Dont include to use development version -pip install . +pip install git+https://git.sr.ht/~armaan/lightcards +``` + +#### Development version +``` +pip install git+https://git.sr.ht/~armaan/lightcards@devel ``` ## Usage See `lightcards --help` for usage information. ## 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. +`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