From e29685d1b1476f8c59b4c14563a449d8385b9399 Mon Sep 17 00:00:00 2001 From: Armaan Bhojwani Date: Mon, 1 Feb 2021 13:54:54 -0500 Subject: [PATCH] Update README --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9bc7879..9330901 100644 --- a/README.md +++ b/README.md @@ -3,21 +3,23 @@ Terminal flashcards from Markdown. ## Installation ### From PyPI -`pip install lightcards` +``` +pip install lightcards +``` ### From Git ``` git clone https://git.sr.ht/~armaan/lightcards cd lightcards -git checkout $(git tag | tail -n 1) # Don't include to use development version -`pip install .` +git checkout $(git tag | tail -n 1) # Dont include to use development version +pip install . ``` ## Usage -see `lightcards --help` +See `lightcards --help` for usage information. ## Input file -See `contrib/example.md` for an example input file +`contrib/example.md` is an example input file. Lightcards takes any valid Markdown or HTML table. Each row is a card, and each of the first two columns is a side. ## License Copyright Armaan Bhojwani 2021, MIT license -- 2.39.2