Comment and clean code

[lightcards.git] / README.md

diff --git a/README.md b/README.md
index ffc1aa1f29508245620045f72ef839bdf0fb45a5..8c7ebd73b6a44cb4c0fc2c1a874ee4f69517a62d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,8 +1,16 @@
 # lightcards
-Lightcards is a terminal program for using flashcards from a Markdown or HTML table. It is currently under heavy development, and unusable for productive studying.
+Terminal flashcards from Markdown.
 
-# Installation
-`pip install .`
+## Installation
+Switch to newest version: `git checkout $(git tag | tail -n 1)`, or use the current development state.
+
+`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