feat: added the ability to set troop type

- Added the ability to set troop type (reflected in the title card)

CHANGELOG.md

@@ -7,15 +7,22 @@ and this project *somewhat* adheres to [Semantic Versioning](https://semver.org/
 ## [Unreleased]
 *nothing*
 
+## [2.1.0] - 2021-09-25
+**The troops have arrived !**
+
+### Added
+- It is now possible to set the type of troop (through the GUI or CLI with -t/--troupe).
+
+### Changed
+- Revamped CLI (docopt and README[_FR]) to reflect new changes.
+
 ## [2.0.0] - 2021-09-25
 **The GUI has landed !** 
 
 ### Added
 - There is now a GUI (can be called with GUI, is used by default if no arguments are passed).
 - Two assets (Taskbar/icon and a GUI graphic).
-
-### Changed
-- Added PySimpleGUI to the requirements.
+- PySimpleGUI added to *requirements.txt*.
 
 ## [1.0.1] - 2021-09-19
 ### Changed
@@ -107,7 +114,8 @@ ImpressionMovieMaker is now smarter and syncs to the soundtrack !
 - Created *ImpressionMovieMaker.py* as  bare-bones python application (takes a rush folder, IN and OUT logo files (video) and music (audio) and makes a passable impression).
 - Created *requirements.txt* for required python libraries (*pip install -r requirements.txt* is your friend.).
 
-[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v2.0.0...HEAD
+[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v2.1.0...HEAD
+[2.1.0]: https://github.com/fetzu/ImpressionMovieMaker/compare/v2.0.0...v2.1.0
 [2.0.0]: https://github.com/fetzu/ImpressionMovieMaker/compare/v1.0.1...v2.0.0
 [1.0.1]: https://github.com/fetzu/ImpressionMovieMaker/compare/v1.0.0...v1.0.1
 [1.0.0]: https://github.com/fetzu/ImpressionMovieMaker/compare/v0.2.1...v1.0.0

README.md

@@ -15,7 +15,7 @@ Simply run ImpressionMovieMaker.py for a half-assed GUI experience.
 For those who like it old-school (and nicer), a CLI interface exists ("*python ImpressionMovieMaker.py --help*" is your friend).
 
 ```
-Usage: ImpressionMovieMaker.py [-hvzpboxdrsmf] [--speed <seconds>] [--gui] [RUSHESFOLDER] [LOGODEBUT] [LOGOFIN] [MUSIQUE] [OUTFILE] [COMPAGNIE] [EXERCICE]
+Usage: ImpressionMovieMaker.py [-hvzpboxdrtsmf] [--troupe=<type>] [--speed <seconds>] [--gui] [RUSHESFOLDER] [LOGODEBUT] [LOGOFIN] [MUSIQUE] [OUTFILE] [COMPAGNIE] [EXERCICE]
 
   Arguments:
     RUSHESFOLDER      Path to folder containing the rushes.
@@ -36,8 +36,10 @@ Usage: ImpressionMovieMaker.py [-hvzpboxdrsmf] [--speed <seconds>] [--gui] [RUSH
     -x                HybridMode: uses both beat tracking and onset detection.
     -d                Drone mode: rushes longer than 1 minute are used. Warning: memory consuming and possibly unstable.
     -r                For hipsters: randomises the sequencing of the rushes.
+    -t --troupe <art>|<mec>|<inf>|<neutre>  
+                      Selects the kind of troop ("art", "mec", "inf" or "neutre").
     -s --slow         Slow cut speeds (each clip will last at least somewhere between 3 and 5 seconds).
-    -m --medium       Medium cut speeds (each clip will last at least somewhere between 1.75 and 3.25 seconds) [default mode].
+    -m --medium       Medium cut speeds (each clip will last at least somewhere between 1.75 and 3.25 seconds) [default].
     -f --fast         Fast cut speeds (each clip will last at least somewhere between 1 and 2 seconds).
     --speed <sec>     Specify the minimum duration of a cut in seconds (overrides pre-set cut speeds).
     --gui             If you'd rather use the GUI.

README_FR.md

@@ -15,7 +15,7 @@ Il est possible d'executer simplement ImpressionMovieMaker.py pour une utilisati
 Pour les plus avisés, une interface CLI existe ("*python ImpressionMovieMaker.py --help*" est votre ami).
 
 ```
-Usage: ImpressionMovieMaker.py [-hvzpboxdrsmf] [--speed <secondes>] [--gui] [RUSHESFOLDER] [LOGODEBUT] [LOGOFIN] [MUSIQUE] [OUTFILE] [COMPAGNIE] [EXERCICE]
+Usage: ImpressionMovieMaker.py [-hvzpboxdrsmf] [--troupe=<type>] [--speed <secondes>] [--gui] [RUSHESFOLDER] [LOGODEBUT] [LOGOFIN] [MUSIQUE] [OUTFILE] [COMPAGNIE] [EXERCICE]
 
   Arguments:
     RUSHESFOLDER      Dossier contenant les rushes.
@@ -31,13 +31,15 @@ Usage: ImpressionMovieMaker.py [-hvzpboxdrsmf] [--speed <secondes>] [--gui] [RUS
     -v                Mode verbose (montre les étapes de travail en détail, en anglais dans le texte).
     -z                Mode "zen"/silencieux (rien dans la console).
     -p                DEV: Montre les arguments passés au programme et les details de clipTrimmer™.
-    -b                BeatMode: utilise la détéction de rythme pour les coupes [par défaut].
+    -b                BeatMode: utilise la détéction de rythme pour les coupes [défaut].
     -o                OnsetMode: utilise la détéction des "onsets" pour les coupes.
     -x                HybridMode: combine la détéction de rythme et des "onsets".
     -d                Mode drone: les clips de drones de plus de 1 minute sont pris en compte. Attention: possiblement instable.
     -r                Pour les hipster: ordre des séquences aléatoire.
+    -t --troupe <art>|<mec>|<inf>|<neutre>  
+                      Définit le type de troupe ("art", "mec", "inf" or "neutre").
     -s --slow         Vitesse de montage lente (chaque séquence dure au moins entre 3 et 5 secondes).
-    -m --medium       Vitesse de montage moyenne (chaque séquence dure au moins entre 1.75 et 3.25 secondes) [par défaut].
+    -m --medium       Vitesse de montage moyenne (chaque séquence dure au moins entre 1.75 et 3.25 secondes) [défaut].
     -f --fast         Vitesse de montage rapide (chaque séquence dure au moins entre 1 et 2 secondes).
     --speed <sec>     Specifier la durée minimale de chaque séquence (remplace les vitesses de montage pré-spécifiées).
     --gui             Pour utiliser l'interface graphique.