Integration w/seedsigner-screenshots as a submodule

.gitignore

@@ -6,7 +6,6 @@ src/seedsigner.egg-info/
 src/seedsigner/models/settings_definition.json
 .idea
 .coverage*
-seedsigner-screenshots
 
 *.po
 *.mo

.gitmodules

@@ -2,3 +2,7 @@
 	path = src/seedsigner/resources/seedsigner-translations
 	url = https://github.com/SeedSigner/seedsigner-translations.git
 	branch = dev
+[submodule "seedsigner-screenshots"]
+	path = seedsigner-screenshots
+	url = https://github.com/SeedSigner/seedsigner-screenshots.git
+	branch = dev

tests/screenshot_generator/generator.py

@@ -444,7 +444,9 @@ def screencap_view(view_cls: View, view_args: dict = {}, view_name: str = None,
 
     # Write the main README; ensure it writes all locales, not just the one that may
     # have been specified for this run.
-    main_readme = """# SeedSigner Screenshots \n\n"""
+    with open(os.path.join("tests", "screenshot_generator", "template.md"), 'r') as readme_template:
+        main_readme = readme_template.read()
+
     for locale, display_name in SettingsConstants.ALL_LOCALES:
         main_readme += f"* [{display_name}]({locale}/README.md)\n"
 

tests/screenshot_generator/template.md

@@ -0,0 +1,16 @@
+# SeedSigner Screenshots 
+
+SeedSigner screenshots can be freely used in any tutorial, article, video, etc. As a courtesy, please link back to this repo or the SeedSigner website in your attribution.
+
+![](en/main_menu_views/MainMenuView.png) ![](en/psbt_views/PSBTOverviewView.png)
+
+![](en/seed_views/SeedOptionsView.png) ![](en/tools_views/ToolsMenuView.png)
+
+
+## Generating screenshots
+The screenshot generator is integrated into the SeedSigner test suite and requires a local copy of the SeedSigner repo with the test suite dependencies installed.
+
+see: https://github.com/SeedSigner/seedsigner/blob/dev/tests/screenshot_generator/README.md
+
+
+## Currently supported or in-progress languages