diff --git a/.gitignore b/.gitignore index 87b75569..9c70709f 100644 --- a/.gitignore +++ b/.gitignore @@ -6,7 +6,6 @@ src/seedsigner.egg-info/ src/seedsigner/models/settings_definition.json .idea .coverage* -seedsigner-screenshots *.po *.mo \ No newline at end of file diff --git a/.gitmodules b/.gitmodules index 70d44391..ececef83 100644 --- a/.gitmodules +++ b/.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 diff --git a/seedsigner-screenshots b/seedsigner-screenshots new file mode 160000 index 00000000..29ddf3e8 --- /dev/null +++ b/seedsigner-screenshots @@ -0,0 +1 @@ +Subproject commit 29ddf3e8f52ed5f612801266ceedc773e530e0aa diff --git a/tests/screenshot_generator/generator.py b/tests/screenshot_generator/generator.py index 671b3b60..e07381da 100644 --- a/tests/screenshot_generator/generator.py +++ b/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" diff --git a/tests/screenshot_generator/template.md b/tests/screenshot_generator/template.md new file mode 100644 index 00000000..ac0f6e23 --- /dev/null +++ b/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