roulette/README.md

34 lines
1.0 KiB
Markdown
Raw Normal View History

2022-09-16 15:52:59 -04:00
## About
2022-10-18 17:58:15 -04:00
Sometimes, you just need a way to randomly display images from your filesystem.
2022-09-16 15:52:59 -04:00
2022-10-18 17:58:15 -04:00
Simply point this tool at one or more directories, and then open the specified port (default `8080`) in your browser.
2022-09-16 15:52:59 -04:00
2022-10-18 17:58:15 -04:00
A new image will be selected if you open `/` directly, or if you click on any displayed image.
2022-09-16 15:52:59 -04:00
Browser history is preserved, so you can always go back to any previously displayed image.
2022-10-18 17:58:15 -04:00
Supported file types and extensions are `jp[e]g`, `png`, `gif`, and `webp`.
2022-09-16 15:52:59 -04:00
Builds available [here](https://cdn.seedno.de/builds/roulette).
## Usage output
```
Usage:
2022-09-16 15:57:40 -04:00
roulette <path> [path2]... [flags]
2022-09-16 15:52:59 -04:00
roulette [command]
Available Commands:
completion Generate the autocompletion script for the specified shell
help Help about any command
version Print version
Flags:
2022-10-18 17:54:01 -04:00
-h, --help help for roulette
-p, --port uint16 port to listen on (default 8080)
-r, --recursive recurse into subdirectories
-v, --verbose log accessed files to stdout
2022-09-16 15:52:59 -04:00
Use "roulette [command] --help" for more information about a command.
2022-10-18 17:54:01 -04:00
```