Skip to content

Commit

Permalink
docs(app): merge screendocs scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
tamara-slosarek authored and tamslo committed Jan 27, 2025
1 parent e60efb4 commit 3db5b56
Show file tree
Hide file tree
Showing 60 changed files with 562 additions and 418 deletions.
23 changes: 14 additions & 9 deletions app/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,25 +132,30 @@ screen.
A simulator with the app in its initial state (or not installed) needs to be
running.

Optional: set the time and status bar items as described in
[screenshots for publishing](#screenshots-for-publishing).

The `generate_screendocs/run.sh` script will create screencasts
and screenshots.

Run the script with `bash generate_screendocs/run.sh`.

### Screencasts

The `generate_screendocs/generate_screencast.sh` script will create screencast.
It uses Xcode to record the screencast and [`ffmpeg`](https://ffmpeg.org/)
to cut the `full.mov` to relevant subsets (needs to be installed).
The script uses uses Xcode to record the screencast and
[`ffmpeg`](https://ffmpeg.org/) to cut the `full.mov` to relevant subsets
(needs to be installed).

To generate GIFs used in the Tutorial,
[ImageMagick](https://imagemagick.org/index.php) is used
(which also needs to be installed).

Run the script with `bash generate_screendocs/generate_screencast.sh`.

## Screenshots
### Screenshots

To update the screenshots in `../docs/screenshots`
The script automatically updates the screenshots in `../docs/screenshots`
(used in [📑 App screens](../docs/App-screens.md),
[📑 User instructions](../docs/User-instructions.html), and the
[README](./README.md)), run the following command:
`bash generate_screendocs/generate_screenshots.sh`.
[README](./README.md)).

If the error `The following MissingPluginException was thrown running a test:
MissingPluginException(No implementation found for method captureScreenshot on
Expand Down
2 changes: 1 addition & 1 deletion app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ application offers to export a detailed description.
PGx report | Gene details | Medication search | Medication details |
:-: | :-: | :-: | :-: |
(a) | (b) | (c) | (d) |
![report_screen](../docs/screenshots/gene-report.png) | ![gene_screen](../docs/screenshots/cyp2d6.png) | ![search_screen](../docs/screenshots/drug-search.png) | ![drug_screen](../docs/screenshots/clopidogrel.png) |
![report_screen](../docs/screenshots/gene-report-all.png) | ![gene_screen](../docs/screenshots/cyp2c9.png) | ![search_screen](../docs/screenshots/drug-search.png) | ![drug_screen](../docs/screenshots/ibuprofen.png) |

_Please note that these screenshots might not represent the latest app version._

Expand Down
Binary file modified app/assets/images/tutorial/05_bottom_navigation_loopable.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified app/assets/images/tutorial/07_ibuprofen_loopable.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified app/assets/images/tutorial/08_report_and_cyp2c9_loopable.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified app/assets/images/tutorial/09_faq_and_more_loopable.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 0 additions & 10 deletions app/generate_screendocs/generate_screenshots.sh

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,13 @@ if $redo_recording; then
sleep 5
export RECORDING_PID=${!}
echo "Recording process up with pid: ${RECORDING_PID}"

# Run sequence in app

echo "Running app"
flutter drive \
--driver=generate_screendocs/test_driver.dart \
--target=generate_screendocs/screencast_sequence.dart \
--target=generate_screendocs/screendocs_sequence.dart \
--dart-define=TIMESTAMP_PREFIX="$timestamp_prefix" \
--dart-define=TEST_USER="$username" \
--dart-define=TEST_PASSWORD="$password" | tee "$flutter_log_path"
Expand Down
66 changes: 0 additions & 66 deletions app/generate_screendocs/screencast_sequence.dart

This file was deleted.

Loading

0 comments on commit 3db5b56

Please sign in to comment.