X-Git-Url: https://git.armaanb.net/?p=lightcards.git;a=blobdiff_plain;f=README.md;fp=README.md;h=8c7ebd73b6a44cb4c0fc2c1a874ee4f69517a62d;hp=b9250f9ddbc9ff65017e25885c8fb90f600d6483;hb=70ceee06ff42fc06e0f4d113df4c8b76e81d007c;hpb=96b5a978329f18d41c480551a11b845cd06849c0 diff --git a/README.md b/README.md index b9250f9..8c7ebd7 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,16 @@ # lightcards Terminal flashcards from Markdown. -# Installation -`make` +## Installation +Switch to newest version: `git checkout $(git tag | tail -n 1)`, or use the current development state. -# Usage +`make` to install for the current user, or `make global` to install for the whole system. + +## Usage see `lightcards --help` +## Input file +See `contrib/example.md` for an example input file + ## License Copyright Armaan Bhojwani 2021, MIT license