Skip to content

Commit 7131ecc

Browse files
committed
Update animated software overview to README
* Add animated gif image with short software overview to README
1 parent 6fdca52 commit 7131ecc

File tree

4 files changed

+133
-210
lines changed

4 files changed

+133
-210
lines changed

NEWS.Rmd

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,9 @@ title: "NEWS"
33
output: html_document
44
---
55

6-
## TODOs
7-
8-
- Because this is a shiny app, I think it would be nice to have a gif in the package README file
9-
showing how to use the app instead of just a screenshot of the interface, or at least a few more
10-
screenshots indicating the steps to run the analysis
11-
126
## v0.6.1
137

8+
- Add animated gif image with short software overview to README
149
- New `Sample output`tab added with extracts from the output for Sylvia's grid
1510
- Additional test raising test coverage to over 90%
1611
- Button to load sample data and get started right away without uploading any data

README.Rmd

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,10 +106,12 @@ ic()
106106

107107
Also, we provide a docker image under
108108
<https://hub.docker.com/repository/docker/markheckmann/openrepgrid.ic> with a short instruction on
109-
how to run it locally. A screenshot of the user interface is displayed in Figure 2. The image shows
110-
a grid dataset from an interview with *Sylvia* which is also contained in the package.
109+
how to run it locally. A video of the software is displayed in Figure 2. It shows the various tabs
110+
and processes a grid dataset from an interview with *Sylvia* which is also contained in the package.
111111

112-
![*Figure 2*: Screenshot of the software.](inst/extdata//02-screenshot.png)
112+
<!-- ![*Figure 2*: Screenshot of the software.](inst/extdata/02-screenshot.png) -->
113+
114+
![*Figure 2*: Software overview.](inst/extdata/software-animation.gif)
113115

114116
The results of the IC analysis are not displayed interactively but are included in an MS Excel file
115117
that can be generated and downloaded. Also the results of the intermediate IC steps as described in

0 commit comments

Comments
 (0)