From 0b15fb63e1eeda2ef62efc04d920cbb9b2276594 Mon Sep 17 00:00:00 2001
From: frarol96 <franz@rolfsvaag.no>
Date: Sat, 30 Sep 2023 11:43:47 +0000
Subject: [PATCH] Update Home

---
 Home.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 58 insertions(+), 2 deletions(-)

diff --git a/Home.md b/Home.md
index 05fa930..0c67990 100644
--- a/Home.md
+++ b/Home.md
@@ -1,3 +1,59 @@
-Welcome to the Wiki.
+# Video2Crops
 
-Video2Crops is a cross-platform program designed to accept multiple video files, which are then processed into a series of still-frames.
\ No newline at end of file
+Video2Crops is a Python GUI application that allows you to process video files, extract frames, and save cropped images based on specified regions of interest (ROIs). This document provides an overview of the program, its usage, limitations, and features.
+
+## Overview
+
+Video2Crops is designed as a graphical user interface (GUI) application using the Tkinter library for Python. It offers the following features:
+
+- Selection of video files for processing.
+- Customization of ROI settings, including size, vertical alignment, and horizontal alignment.
+- Optional image saving and real-time video playback.
+- Frame selection based on a threshold value to discard low-quality frames.
+- Logging of processing details.
+
+## Usage
+
+1. **Adding Video Files:**
+   - Click on the "Select Files" button to choose video files for processing. Supported formats include .mp4, .avi, and .mov.
+
+2. **ROI Settings:**
+   - Access the "Preferences" menu to customize ROI settings, such as ROI size, vertical alignment, and horizontal alignment.
+   - ROI Size: Adjust the size of the ROI (region of interest) for frame extraction.
+
+3. **Processing Files:**
+   - After adding video files, click on the "Process Files" button to begin processing.
+   - Video frames are extracted and analyzed based on the specified ROI settings.
+   - Frames with a quality (value) above the threshold are saved as cropped images.
+
+4. **Real-time Playback (Optional):**
+   - Enable the "Display Playback" option in the preferences to view video playback while processing.
+   - Press 'q' in the video playback window to exit.
+
+5. **Output:**
+   - Cropped images are saved in an output folder with filenames indicating the frame number.
+   - Processing details are logged in a 'logfile.txt' within the output folder.
+
+6. **Queue Management:**
+   - Use the "Queue" menu to add files, clear the queue, or cancel processing.
+   - "Cancel & Clear" cancels processing and clears the queue.
+
+## Limitations
+
+- Supported Video Formats: The program currently supports only a limited set of video formats (.mp4, .avi, .mov).
+
+- User Interface: The GUI is basic and may lack advanced features found in dedicated video editing software.
+
+- Performance: Processing large video files may be slow, depending on system resources and video quality.
+
+- Error Handling: The program may not handle all possible error cases gracefully.
+
+- Output Folder: Images are saved in the same folder as the input video file. The program does not allow the user to specify a different output directory.
+
+## Version Information
+
+- Video2Crops Version: 1.0.0
+
+---
+
+**Disclaimer:** This document provides an overview of the Video2Crops program. This program comes with no warranty or guarantees, and the developer is not responsible for any potential issues or damages as a result of running Video2Crops.
\ No newline at end of file