minor doc updates

photobooth-app · Dec 21, 2024 · 6fba120 · 6fba120
1 parent 4aa7c0d
commit 6fba120
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 53 deletions.
diff --git a/docs/download.md b/docs/download.md
@@ -1,11 +1,10 @@
 # Download
 
-This app comes as a pip package.
-To download and run this photobooth-app you need two items:
+The photobooth-app comes as a python pip package and needs python installed to run.
 
-- [python >=3.9](https://www.python.org/downloads/) including package installer pip
-- [photobooth-app latest PyPi package](https://pypi.org/project/photobooth-app/)
-
-On Linux python is usually already available. On windows download python from the website above.
+Download the app from pypi directly:
 
-The [installation process is described here](./setup/installation.md) in detail.
+- [photobooth-app latest PyPi package](https://pypi.org/project/photobooth-app/)
+The [installation process](./setup/installation.md) is described here in detail.
+- [python 3.10 or higher](https://www.python.org/downloads/)
+On Linux python is usually already available. On windows download python from the website.
diff --git a/docs/index.md b/docs/index.md
@@ -14,38 +14,46 @@ Excited? This is how the app looks like. It's a website and can be displayed on
 
 <div class="grid cards" markdown>
 
-- :material-clock-fast:{ .lg .middle } __Set up in 5 minutes__
+- :stopwatch:{ .lg .middle } __Set up in 5 minutes__
 
     ---
 
-    Install [`photobooth-app`](https://pypi.org/project/photobooth-app/) pip and get up
-    and running in minutes
+    Install the [`photobooth-app`](https://pypi.org/project/photobooth-app/) using pip to get up
+    and running in minutes!
 
     [:octicons-arrow-right-24: Installation](./setup/installation.md)
 
-- :material-camera:{ .lg .middle } __All camera types supported__
+- :star:{ .lg .middle } __Modern Webinterface__
 
     ---
 
-    Use your DSLR, webcamera or Raspberry Pi Camera with the app. You can even use 2 cameras at the same time, one for liveview, one for stills.
+    The webinterface is reactive and simple to use for everybody.
 
-    [:octicons-arrow-right-24: Camera Setup](./setup/camera_setup.md)
+    [:octicons-arrow-right-24: See screenshots](./screenshots.md)
 
-- :material-multimedia:{ .lg .middle } __Capture__
+- :camera_with_flash:{ .lg .middle } __All camera types supported__
 
     ---
 
-    Create photos, collages and animated GIFs. Apply nice looking filter in postprocessing.
+    Use your DSLR, webcamera or Raspberry Pi Camera with the photobooth-app. You can even use 2 cameras at the same time, one for liveview, one for stills.
+
+    [:octicons-arrow-right-24: Camera setup](./setup/camera_setup.md)
+
+- :video_camera:{ .lg .middle } __Capture__
+
+    ---
+
+    Create photos, collages and animated GIFs and videos. Apply nice looking filter in postprocessing.
 
     [:octicons-arrow-right-24: Postprocessing](./setup/mediaprocessing.md)
 
-- :material-scale-balance:{ .lg .middle } __Open Source, MIT__
+- :stars:{ .lg .middle } __Many more features__
 
     ---
 
-    The photobooth-app is licensed under MIT and available on GitHub.
+    Explore a detailed list of features and compare with other open source projects.
 
-    [:octicons-arrow-right-24: License](https://github.com/photobooth-app/photobooth-app/blob/main/LICENSE.md)
+    [:octicons-arrow-right-24: More features](./features.md)
 
 </div>
 

diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md
@@ -69,38 +69,6 @@ To trigger an action via keypress define the keycode. If you're unsure what keyc
 !!! info
     Enable the keyboard processing in admin dashboard -> configuration -> hardwareinput/output!
 
-## Printer
-
-TODO
-
-## Sharing
-
-TODO
-
-## Filetransfer
-
-TODO
-
-## Mediaprocessing
-
-TODO
-
-## UI Settings
-
-TODO
-
-## Backends
-
-TODO
-
-## Hardware Input / Output
-
-TODO
-
-## Misc
-
-TODO
-
 ## Questions remain?
 
 Reach out in a [discussion](https://github.com/photobooth-app/photobooth-app/discussions).
diff --git a/docs/setup/installation.md b/docs/setup/installation.md
@@ -6,7 +6,7 @@ You have seen the 3d printable photobooth box? [Check out the photobooth box!](h
 
 ## Prerequisites
 
-- Python 3.9 or later.
+- Python 3.10 or later.
 - System: Raspberry Pi 4 or 5 recommended. Hardware more performant is fine also using a generic Debian/Windows. Raspberry Pi 3 could work also but might be slow.
 - Screen: Touchscreen highly recommended. Minimum resolution is 1024x600.
 - Camera, can be one or two (first camera for stills, second camera for live view)

diff --git a/docs/setup/mediaprocessing.md b/docs/setup/mediaprocessing.md
@@ -78,7 +78,12 @@ The animated gif pipeline runs following stages in given sequence:
 
 ### Video-Pipeline
 
-Feature not yet implemented. You're invited to contribute. 👋
+The videos are created from cameras livestream if available.
+There are basic options currently to set:
+
+  1. The maximum duration of a video. The caputure process is stoppable by the user before the maximum duration is reached.
+  2. Boomerang option enable to append the video in reverse.
+  3. Choose a framerate of the video.
 
 ### Print-Pipeline
 
@@ -89,7 +94,6 @@ Feature not yet implemented. You're invited to contribute. 👋
 ### Chromakeying
 
 Remove a color from the captured image. Removed parts will be transparent.
-TODO: add more description about how to choose the green value.
 
 ### Instagram-Like Color-Filter