From 7e07e38ab2fa61d3950fc5f2637363f19ef63bfa Mon Sep 17 00:00:00 2001 From: luxick Date: Thu, 14 May 2020 17:31:49 +0200 Subject: [PATCH] Add README. --- README.md | 22 ++++++++++++++++++++++ src/randopix.nim | 2 +- 2 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..918d533 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# randopix +## Usage +``` +randopix + +Version 0.1 - Display random images from different sources + +Usage: + randopix [options] + +Options: + -m, --mode=MODE foxes, inspiro, inspiro-xmas + -w, --windowed Do not start in fullscreen mode + -h, --help Show this help +``` +## Build +Install the [Nim Compoiler](https://nim-lang.org/install.html). + +Use this command to install the dependencies and build the program: +``` +$ nimble release +``` \ No newline at end of file diff --git a/src/randopix.nim b/src/randopix.nim index fabea77..ecb78ef 100644 --- a/src/randopix.nim +++ b/src/randopix.nim @@ -19,7 +19,7 @@ var mode: Option[Mode] argParser = newParser("randopix"): help(fmt"Version {version} - Display random images from different sources") - option("-m", "--mode", help="One of these: foxes, inspiro, inspiro-xmas") + option("-m", "--mode", help="foxes, inspiro, inspiro-xmas") flag("-w", "--windowed", help="Do not start in fullscreen mode") proc downloadFox(): Pixbuf =