X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=README.md;h=4dd7dc9e62f960bc86207e04e1bb1bbb58b3be2f;hb=b9185b09edd2677f3a63cef4fd4be3e79671dc5c;hp=8c7ebd73b6a44cb4c0fc2c1a874ee4f69517a62d;hpb=70ceee06ff42fc06e0f4d113df4c8b76e81d007c;p=lightcards.git diff --git a/README.md b/README.md index 8c7ebd7..4dd7dc9 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,27 @@ Terminal flashcards from Markdown. ## Installation -Switch to newest version: `git checkout $(git tag | tail -n 1)`, or use the current development state. +### From PyPI +``` +pip install lightcards +``` -`make` to install for the current user, or `make global` to install for the whole system. +### From Git +#### Main branch (stable) +``` +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` +See `lightcards --help` or `man lightcards` 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