]> git.armaanb.net Git - lightcards.git/commitdiff
Update README
authorArmaan Bhojwani <me@armaanb.net>
Sun, 31 Jan 2021 15:58:26 +0000 (10:58 -0500)
committerArmaan Bhojwani <me@armaanb.net>
Sun, 31 Jan 2021 15:58:26 +0000 (10:58 -0500)
README.md

index b9250f9ddbc9ff65017e25885c8fb90f600d6483..8c7ebd73b6a44cb4c0fc2c1a874ee4f69517a62d 100644 (file)
--- 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