Update README

danopdev · Feb 17, 2023 · 3a8826e · 3a8826e
1 parent 24187e5
commit 3a8826e
Show file tree

Hide file tree

Showing 27 changed files with 36 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -3,65 +3,69 @@
 Create timelapse videos from another video or a series of photos (the photos will be sorted alphabetically).
 
 * [Main screen](#main-screen)
-  * [Open](#open)
+  * [Toolbar](#toolbar)
   * [Parameters](#parameters)
-  * [Generate and preview](#generate-and-preview)
-  * [Save](#save)
+  * [Media](#media)
 * [Examples](#examples)
   * [Smooth](#smooth)
   * [Transition](#transition)
+  * [Other](#other)
 
 ## Main screen
-![](screenshots/main_screen_small.jpg)
+![](screenshots/main-screen.jpg)
 
 
-### Open
-![](screenshots/source.jpg)
+### Toolbar
+![](screenshots/toolbar.jpg)
 
-Allow to open a videso a series of photos or a photo folder.
+In order:
+* Open a video file
+* Save the generated video
+* ... contains
+  * Open a series of images
+  * Open an images folder
+  * Save the last frame a image (full size)
+  * Settings
 
 ### Parameters
 ![](screenshots/parameters.jpg)
 
-* Speed: allow to keep only one of "speed" frames. Example: 3x means use only one of 3 frames. 1x means use all frames.
-* Smooth: allow to do the moving average of N frames. 1x means disabled.
-* Transition: make a linear transition between 2 consecutive frames. 1x means disabled
-* Output FPS
+* Speed: allow to sub-sample input frames (keep only one of "speed" frames). Example: 3x means use only one of 3 frames. 1x means use all frames.
+* Align: allow to align frame (for still). If needed you can create a mask.
+* Effect: You can select one from the list. Some effect have an extra parameter. For example for Average, 2x means it will output an average of 2 consecutive frames in a sliding window. Ex: 0 and 1, then 1 and 2 ... . It's better to experiment.
+* Output FPS: by default it will match the input but can be changed.
+* Duration: you can generate a smaller video to test it before creating the full one.
+* Orientation: auto (landscape or portrait, depends on the input), landscape or portrait
 
-### Generate and preview
-![](screenshots/generate.jpg)
+### Media
+![](screenshots/media.jpg)
 
-Generate the video based on the current parametes.
-Once generated the Play / Stop buttons will be enabled and allow to see the result.
-
-### Save
-![](screenshots/menu_save.jpg)
-
-Allow to save the current generated video to Gallery.
+In order:
+* Play the original video (don't works if the input is a series of images)
+* Play the generated video (it will generate it if needed)
+* Stop the player
 
 ## Examples
 
 ### Smooth
 
-Original
-
-https://user-images.githubusercontent.com/7062741/214269986-4b287156-cd43-4a96-bf95-36967745e808.mp4
+Original on left vs smooth 10x on right.
 
-Smooth 10x
-
-https://user-images.githubusercontent.com/7062741/214269664-9f539752-fb04-49af-8795-b440b7857dba.mp4
+![](examples/smooth/original_vs_smooth_10x.gif)
 
 ### Transition
 
 Input images
 1 | 2 | 3 | 4
 -- | -- | -- | --
-![](examples/transition/input_1_small.jpg) | ![](examples/transition/input_2_small.jpg) | ![](examples/transition/input_3_small.jpg) | ![](examples/transition/input_4_small.jpg)
-
-Crop
+![](examples/transition/input_1.jpg) | ![](examples/transition/input_2.jpg) | ![](examples/transition/input_3.jpg) | ![](examples/transition/input_4.jpg)
 
-https://user-images.githubusercontent.com/7062741/214270355-cea5f6d1-41be-4d9d-9397-bf616a3d6af3.mp4
+Crop | No Crop
+-- | --
+![](examples/transition/crop.gif) | ![](examples/transition/no-crop.gif)
 
-No Crop
+### Other
 
-https://user-images.githubusercontent.com/7062741/214270380-ec2290fc-5a96-499f-b916-b6b287233821.mp4
+Normal | Endless Lightest Pixels
+-- | --
+![](examples/other/simple.gif) | ![](examples/other/endless-lightest-pixels.gif)
diff --git a/examples/other/endless-lightest-pixels.gif b/examples/other/endless-lightest-pixels.gif
diff --git a/examples/other/simple.gif b/examples/other/simple.gif
diff --git a/examples/smooth/input.mp4 → examples/smooth/original_vs_smooth_10x.gif b/examples/smooth/input.mp4 → examples/smooth/original_vs_smooth_10x.gif
diff --git a/examples/smooth/output.mp4 b/examples/smooth/output.mp4
diff --git a/examples/transition/crop.gif b/examples/transition/crop.gif
diff --git a/examples/transition/input_1.jpg b/examples/transition/input_1.jpg
diff --git a/examples/transition/input_1_small.jpg b/examples/transition/input_1_small.jpg
diff --git a/examples/transition/input_2.jpg b/examples/transition/input_2.jpg
diff --git a/examples/transition/input_2_small.jpg b/examples/transition/input_2_small.jpg
diff --git a/examples/transition/input_3.jpg b/examples/transition/input_3.jpg
diff --git a/examples/transition/input_3_small.jpg b/examples/transition/input_3_small.jpg
diff --git a/examples/transition/input_4.jpg b/examples/transition/input_4.jpg
diff --git a/examples/transition/input_4_small.jpg b/examples/transition/input_4_small.jpg
diff --git a/examples/transition/no-crop.gif b/examples/transition/no-crop.gif
diff --git a/examples/transition/output_crop.mp4 b/examples/transition/output_crop.mp4
diff --git a/examples/transition/output_no_crop.mp4 b/examples/transition/output_no_crop.mp4
diff --git a/screenshots/generate.jpg b/screenshots/generate.jpg
diff --git a/screenshots/input-info.jpg b/screenshots/input-info.jpg
diff --git a/screenshots/main-screen.jpg b/screenshots/main-screen.jpg
diff --git a/screenshots/main_screen.jpg b/screenshots/main_screen.jpg
diff --git a/screenshots/main_screen_small.jpg b/screenshots/main_screen_small.jpg
diff --git a/screenshots/media.jpg b/screenshots/media.jpg
diff --git a/screenshots/menu_save.jpg b/screenshots/menu_save.jpg
diff --git a/screenshots/parameters.jpg b/screenshots/parameters.jpg
diff --git a/screenshots/source.jpg b/screenshots/source.jpg
diff --git a/screenshots/toolbar.jpg b/screenshots/toolbar.jpg