]> git.armaanb.net Git - lightcards.git/blobdiff - man/lightcards.1.md
Update manpage
[lightcards.git] / man / lightcards.1.md
index 42259ec619f3992311ff63158af43008a28b9df2..96e8cccdc1aeecf1c06d03e8ff33e3549c566abb 100644 (file)
@@ -6,10 +6,14 @@
 Lightcards - simple terminal flashcards.
 
 # SYNOPSIS
-lightcards [[options]] [[input file]]
+lightcards [[options]] [input file]
 
 # DESCRIPTION
-**lightcards** is a Python script that reads data from a markdown table, and creates flashcards from them.
+**lightcards** is a Python program that reads data from a two column Markdown or HTML table, and displays flashcards based on their contents.
+
+# POSITIONAL ARGUMENTS
+**input file**
+: Relative or absolute path to the input Markdown or HTML file
 
 # OPTIONS
 **-h**, **--help**