]> git.armaanb.net Git - lightcards.git/blobdiff - man/lightcards.1.md
Add reverse option
[lightcards.git] / man / lightcards.1.md
index 42259ec619f3992311ff63158af43008a28b9df2..3b5d8d2faa74e375d23124da6c31c38e5894bb1b 100644 (file)
@@ -1,4 +1,4 @@
-% lightcards(1) 0.0.0
+% lightcards(1) 0.2.0
 % Armaan Bhojwani
 % January 2021
 
@@ -6,17 +6,27 @@
 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**
 : Show a help message and exit
 
+**-r**, **--reverse**
+: Reverse card order. Has no effect when shuffling as well
+
+**-s**, **--shuffle**
+: Shuffle card order
+
 **-v**, **--version**
-: Print version
+: Print version and exit
 
 # EXIT VALUES
 **0**