Merge pull request #67 from xSAVIKx/add-screenshots

Improve docs

Author: xSAVIKx

.github/workflows/ci.yaml

@@ -1,4 +1,4 @@
-name: Java CI
+name: CI
 
 on:
   push:

README.md

@@ -6,7 +6,7 @@ AndroidScreencast
 [![Join the chat at https://gitter.im/AndroidScreencast/Lobby][gitter_badge]][gitter] 
 [![Apache License][license_badge]][license]
 
-[actions_badge]: https://github.com/xSAVIKx/AndroidScreencast/workflows/CI/badge.svg?branch=master
+[actions_badge]: https://github.com/xSAVIKx/AndroidScreencast/workflows/CI/badge.svg
 [actions]: https://github.com/xSAVIKx/AndroidScreencast/actions
 
 [versioneye_badge]: https://www.versioneye.com/user/projects/58a746d8b4d2a20055fcb887/badge.svg?style=flat
@@ -43,25 +43,26 @@ This project gives the opportunity to use your phone even with a broken screen.
 ## Configuration
 
 There are 2 ways to run application:
-1. Run ADB server on your own
-2. Provide correct `app.properties` file
+
+1. Run ADB server on your own.
+2. Provide a correct `app.properties` file.
 
 ### Run ADB server on your own
 
-In order to run server on your own you have to run already installed (or one from our 
-OS-specific bundle) `adb` with following command:
+In order to run server on your own you have to run already installed (or one from our OS-specific bundle) `adb` with
+following command:
 
-```
+```bash
 adb start-server
 ```
 
 **Note**:
 
-If `app.properties` will have `adb.path` filled - AndroidScreencast will shutdown ADB server 
-on application termination.
+If `app.properties` will have `adb.path` filled, AndroidScreencast will shutdown the ADB server on application
+termination.
 
-Additionally, in order to use, for example, remote ADB server with ssh forwarding you should not 
-use `app.properties` or `adb.path` property should be commented.
+Additionally, in order to use for example remote ADB server with ssh forwarding you should not use `app.properties`
+or `adb.path` property should be commented.
 
 ### Provide correct `app.properties` file
 
@@ -78,7 +79,7 @@ Both absolute and relative paths are supported.
 
 Example of valid `app.properties` could be find [here](app.properties).
 
-Also we have got some valid OS-specific examples:
+Also, we have got some valid OS-specific examples:
 
 * [OSX app.properties](adb/macosx/app.properties)
 * [Windows app.properties](adb/windows/app.properties)
@@ -112,7 +113,7 @@ app.native.look=false
 
 Application is available using Java web start technology via [androidscreencast.jnlp][jnlp].
 
-[jnlp]: http://xsavikx.github.io/AndroidScreencast/jnlp/androidscreencast.jnlp
+[jnlp]: https://xsavikx.github.io/AndroidScreencast/jnlp/androidscreencast.jnlp
 
 ### Java security configuration
 
@@ -136,7 +137,7 @@ replacing `VERSION` with the current version.
 
 For example, `java -jar target/androidscreencast-0.0.10s-executable.jar`.
 
-Additionally OS-packages would be created with ADB executables bundled:
+Additionally, OS-packages would be created with ADB executables bundled:
 
 * `androidscreencast-VERSION-windows.zip`
 * `androidscreencast-VERSION-linux.tar.gz`

docs/assets/androidscreencast.mov

@@ -10,6 +10,18 @@ AndroidScreencast was developed to view and control your android device from a P
 
 This project gives the opportunity to use your phone even with a broken screen.
 
+The main screen:
+
+![AndroidScreencast - Main screen](./assets/main.png)
+
+Commands execution screen:
+
+![AndroidScreencast - Execute command](./assets/exec-command.png)
+
+Video recorded by the app:
+
+<video src="{{ site.baseurl }}/assets/androidscreencast.mov" type="video/mp4"/></video>
+
 ## Features
 
 - No client needed
@@ -40,15 +52,23 @@ To use JNLP, please follow this article: [How can I configure the Exception Site
 
 # Requirements
 
-Currently AndroidScreencast works directly with `adb input` program through `ddmlib` and abuse functionality of:
+Currently, AndroidScreencast works directly with `adb input` program through `ddmlib` and uses functionality of:
+
 - `adb input key`
 - `adb input tap`
 - `adb input swipe`
 
-Regarding this point, to use AndroidScreencast you need Smartphone running on Android with specific `input` program version. `adb input tap` and `adb input swipe` were introduced in [Android 4.1.1][Android_4_1_1_Input].
+Regarding this point, to use AndroidScreencast you need Smartphone running on Android with specific `input`
+program version. `adb input tap` and `adb input swipe` were introduced in [Android 4.1.1][Android_4_1_1_Input].
 
 So, right now AndroidScreencast support all Android versions equal or greater than Android 4.1.1.
 
 Also, to run AndroidScreencast you will need *adb* installed (or you can use bundled in OS bundles adb).
 
 [Android_4_1_1_Input]: http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/4.1.1_r1/com/android/commands/input/Input.java#Input
+
+# More info
+
+Please refer to the project's [GitHub page][github] for more detailed overview and specific instructions.
+
+[github]: https://github.com/xSAVIKx/AndroidScreencast

docs/assets/exec-command.png

@@ -117,7 +117,8 @@ private void display(final RawImage rawImage) {
         if (qos != null) {
             SwingUtilities.invokeLater(() -> {
                 try {
-                    qos.writeFrame(image, FRAME_DURATION);
+                    if (qos != null)
+                        qos.writeFrame(image, FRAME_DURATION);
                 } catch (IORuntimeException e) {
                     log().error("IO exception happened during writing the video frame: {}.", image, e);
                 }