diff --git a/README.md b/README.md index 4a33bd0..cb379be 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,21 @@ +# UNMAINTAINED AND BROKEN + +Used to work, does not anymore, maybe can be still of interest for someone + # GOG-SYNC + ## **Please note that this is alpha software, you should not trust it.** A small tool to synchronize the stuff in a [GOG](https://www.gog.com/) library with a local folder. -It builds on the work of the [unofficial GOG API Documentation](https://gogapidocs.readthedocs.io/en/latest/). +It builds on the work of the +[unofficial GOG API Documentation](https://gogapidocs.readthedocs.io/en/latest/). This is the first time I am building something with rust, so beware :) # Installation + Install from [crates.io](https://crates.io/crates/gog-sync). ``` @@ -16,8 +23,9 @@ cargo install gog-sync ``` # Configuration -The configuration file is in the config folder as described by the xdg specification -with a prefix of `gog-sync`. + +The configuration file is in the config folder as described by the xdg +specification with a prefix of `gog-sync`. For example on macOS or Linux @@ -39,27 +47,32 @@ A bare configuration with default values before first use: } ``` -- *gameStorage*: Where to save games -- *movieStorage*: Where to save movies -- *osFilters*: An array of operating systems. If it is not empty, game data is limited to the ones in the list. -- *languageFilters*: An array of languages. If it is not empty, game data is limited to the ones in the list. -- *resolutionFilters*: An array of resolutions. If it is not empty, movie data is limited to the ones in the list. -- *skipMovies*: Whether to skip movie content -- *skipGames*: Whether to skip game content +- _gameStorage_: Where to save games +- _movieStorage_: Where to save movies +- _osFilters_: An array of operating systems. If it is not empty, game data is + limited to the ones in the list. +- _languageFilters_: An array of languages. If it is not empty, game data is + limited to the ones in the list. +- _resolutionFilters_: An array of resolutions. If it is not empty, movie data + is limited to the ones in the list. +- _skipMovies_: Whether to skip movie content +- _skipGames_: Whether to skip game content -Valid values for *osFilter*: -- `linux` -- `mac` -- `windows` +Valid values for _osFilter_: + +- `linux` +- `mac` +- `windows` Check on [gog.com](https://www.gog.com/) which languages are available. An incomplete list of resolutions on gog: -- `DVD` -- `576p` -- `720p` -- `1080p` -- `4k` + +- `DVD` +- `576p` +- `720p` +- `1080p` +- `4k` # Usage @@ -90,8 +103,8 @@ OPTIONS: gog-sync ``` -Normal invocation, uses the current working directory as storage if not configured -otherwise. +Normal invocation, uses the current working directory as storage if not +configured otherwise. ---