Skip to content

Commit

Permalink
Integration w/seedsigner-screenshots as a submodule
Browse files Browse the repository at this point in the history
  • Loading branch information
kdmukai committed Nov 6, 2024
1 parent 7a8609f commit fae400d
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 2 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ src/seedsigner.egg-info/
src/seedsigner/models/settings_definition.json
.idea
.coverage*
seedsigner-screenshots

*.po
*.mo
4 changes: 4 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 1 addition & 0 deletions seedsigner-screenshots
Submodule seedsigner-screenshots added at 29ddf3
4 changes: 3 additions & 1 deletion tests/screenshot_generator/generator.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down
16 changes: 16 additions & 0 deletions tests/screenshot_generator/template.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit fae400d

Please sign in to comment.