Add README.
This commit is contained in:
22
README.md
Normal file
22
README.md
Normal file
@@ -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
|
||||||
|
```
|
||||||
@@ -19,7 +19,7 @@ var
|
|||||||
mode: Option[Mode]
|
mode: Option[Mode]
|
||||||
argParser = newParser("randopix"):
|
argParser = newParser("randopix"):
|
||||||
help(fmt"Version {version} - Display random images from different sources")
|
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")
|
flag("-w", "--windowed", help="Do not start in fullscreen mode")
|
||||||
|
|
||||||
proc downloadFox(): Pixbuf =
|
proc downloadFox(): Pixbuf =
|
||||||
|
|||||||
Reference in New Issue
Block a user