Merge pull request #2 from hiulit/develop

Develop

.editorconfig

@@ -0,0 +1,13 @@
+# editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

.gitignore

@@ -0,0 +1 @@
+logs/

CHANGELOG.md

@@ -4,6 +4,27 @@
 
 * Up to date
 
+## [2.0.0] - 2018-09-07
+
+### Added
+
+* Option to install/Uninstall the script from EmulationStation's RetroPie menu.
+* GUI mode.
+* Debug mode - To test the script. No harm will done to the gamelists ;)
+* Log files - Found in `/home/pi/Retropie-Limit-Last-Played-Games/logs`).
+
+### Fixed
+
+* Uncommented code preventing to actually remove 'last played' games.
+* Fixed [#1 - Only show systems that have a gamelist.xml](https://github.com/hiulit/RetroPie-Limit-Last-Played-Games/issues/1).
+
+### Changed
+
+* Refactored the code to create backups. Now the folder is called `gamelist-backups` (inside the `$SYSTEM_ROMS` folder) and contains all the game lists backups, named `[DATE]-gamelist-backup.xml`.
+* Added more `error/success` output messages.
+* Better control of what games have to be processed.
+
+
 ## [1.0.0] - 2018-03-01
 
 * Released version [1.0.0](https://github.com/hiulit/RetroPie-Limit-Last-Played-Games/releases/tag/1.0.0).

README.md

@@ -23,11 +23,19 @@ git pull
 ./retropie-limit-last-played-games.sh [OPTIONS]
 ```
 
-### Example
+### Examples
 
 `./retropie-limit-last-played-games.sh --nth 25 --systems`
 
-This will set the number of 'last played' games to limit at 25 and then it will show a dialog from where it can selected as many systems as needed.
+This will set the number of 'last played' games to limit at 25 and then it will show a dialog from where it can be selected as many systems as needed.
+
+`./retropie-limit-last-played-games.sh --nth 25 --systems --debug`
+
+This will set the debug mode on. It's perfect for testing the script before actually 'harming' the gamelists.
+
+`./retropie-limit-last-played-games.sh --gui`
+
+This will start the GUI. It will ask you to enter a number to limit the number of 'last played' the games shown. Then it will ask you to choose the desired systems to apply that limit.
 
 If no options are passed, you will be prompted with a usage example:
 
@@ -40,8 +48,12 @@ Use './retropie-limit-last-played-games.sh --help' to see all the options.
 ## Options
 
 * `--help`: Print the help message and exit.
+* `--install`: Install the script in EmulationStation's RetroPie menu.
+* `--uninstall`: Uninstall the script from EmulationStation's RetroPie menu.
 * `--nth`: Set number of 'last played' games to limit per system (10 by default).
 * `--systems`: Show dialog to select systems to limit.
+* `--gui`: Start the GUI.
+* `--debug`: Set debug mode to test the script.
 * `--version`: Show script version.
 
 ## Examples
@@ -54,6 +66,24 @@ Print the help message and exit.
 
 `./retropie-limit-last-played-games.sh --help`
 
+### `--install`
+
+Install the script in EmulationStation's RetroPie menu.
+
+You'll find it as 'Limit Last Played Games'.
+
+#### Example
+
+`./retropie-limit-last-played-games.sh --install`
+
+### `--uninstall`
+
+Uninstall the script from EmulationStation's RetroPie menu.
+
+#### Example
+
+`./retropie-limit-last-played-games.sh --uninstall`
+
 ### `--nth [OPTIONS]`
 
 Set number of 'last played' games to limit per system (10 by default).
@@ -66,14 +96,36 @@ Set number of 'last played' games to limit per system (10 by default).
 
 `./retropie-limit-last-played-games.sh --nth 25`
 
+The `--nth` option won't do anything by itself. It always has to be accompanied, at least, by `--systems`.
+
 ### `--systems`
 
-Show dialog to select systems to limit.
+Show a dialog to select the system/s to limit.
 
 #### Example
 
 `./retropie-limit-last-played-games.sh --systems`
 
+### `--gui`
+
+Start the GUI.
+
+It lets you use the script in a more friendly way.
+
+#### Example
+
+`./retropie-limit-last-played-games.sh --gui`
+
+### `--debug`
+
+Set debug mode to test the script.
+
+No harm will done to the gamelists ;)
+
+#### Example
+
+`./retropie-limit-last-played-games.sh --debug`
+
 ### `--version`
 
 Show script version.