From: Armaan Bhojwani Date: Sun, 31 Jan 2021 15:58:26 +0000 (-0500) Subject: Update README X-Git-Tag: v0.3.0~14 X-Git-Url: https://git.armaanb.net/?p=lightcards.git;a=commitdiff_plain;h=70ceee06ff42fc06e0f4d113df4c8b76e81d007c Update README --- 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