X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=README.md;h=4dd7dc9e62f960bc86207e04e1bb1bbb58b3be2f;hb=86eaf8495475ffb986efcd7fbf11ada2835c88e4;hp=d9ba139524820ccaa9d0314a037bf177fd76fc72;hpb=49c06ce42a82667180250ee97d0aceabb812f947;p=lightcards.git diff --git a/README.md b/README.md index d9ba139..4dd7dc9 100644 --- a/README.md +++ b/README.md @@ -8,15 +8,18 @@ pip install lightcards ``` ### From Git +#### Main branch (stable) ``` -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 branch +``` +pip install git+https://git.sr.ht/~armaan/lightcards@devel ``` ## Usage -See `lightcards --help` for usage information. +See `lightcards --help` or `man lightcards` for usage information. ## 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.