From 0e4bfcdb913006d2df58ecc6825e43b15d022233 Mon Sep 17 00:00:00 2001 From: Felipe Martin Date: Mon, 9 Nov 2020 21:16:13 +0100 Subject: [PATCH] Added README --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e01f95f --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# Games Screenshot Manager + +A simple tool to collect and sort games screenshots from different platforms. + +## Supported platforms + +| Name | Comments | +| --- | --- | +| Steam | Linux only at the moment + +## How it works + +Each provider has it's own way of finding the screenshots, but ideally the screenshots folder for games are known to us users so we only need to traverse them and find image files. + +When talking about a game's store (Steam, for example) we need to retrieve a bit more info from internet to identify each game name from the internal ID used by Steam on disk. + +For more details, you can check out [the source code for all providers](https://github.com/fmartingr/games-screenshot-manager/tree/master/pkg/providers) + +## Installation + +``` +go get -u github.com/fmartingr/games-screenshot-manager +``` + +Or get a binary build from the [releases page](https://github.com/fmartingr/games-screenshot-manager/releases) + +## Usage + +``` +# Help +games-screenshot-manager -h + +# Fetch and sort all Steam screenshots into ./Output +games-screenshot-manager -provider steam -output-path ./Output + +# Perform a dry run (see what's gonna get copied where) +games-screenshot-mananger -provider steam -dry-run +```