diff --git a/README.md b/README.md new file mode 100644 index 0000000..b344be6 --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# Random File Runner + +> Run a file at random from a list of discovered files. + +![Screenshot](wiki/screenshot-1.png) + +--- + +## Features + +- Search for files using a wildcard pattern +- Support patterns with multiple wilcards +- Run a random file from the list +- Support global hotkey for running next file + +--- + +## Screenshots + +| Dashboard | Settings | +|-----------|----------| +| ![](wiki/screenshot-1.png) | + +--- + +## Background + +This tool is an odd one, it might just be one of those tools that are only useful to me. +I wanted to search (a set of given) directories for files that match a wildcard pattern. +Then I wanted to run a file (from that list) at random. +For example: you wanted to watch a random episode of your favourite show. + +## Acknowledgements + +This software uses a number of dependencies and assets from third-parties. +These developers and artists deserve due credit for their work and for their commitment to sharing their work freely. +Each product is released under their own particular license, for more information please visit their websites. + +- [Feather - Simply Beautiful Open Source Icons](https://feathericons.com/) +- [Lucide](https://lucide.dev/icons/) + +--- + +## 📄 License + +This project is licensed under the least restrictive terms of its dependencies, viz. MIT License. \ No newline at end of file diff --git a/wiki/screenshot-1.png b/wiki/screenshot-1.png new file mode 100644 index 0000000..f23f5c0 Binary files /dev/null and b/wiki/screenshot-1.png differ