diff --git a/README.md b/README.md index 24c56d1..2cb18ee 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,18 @@ # OptimaLab35 -UI for [OPTIMA35](https://gitlab.com/CodeByMrFinchum/optima-35) package, WIP. + +[OptimaLab35](https://gitlab.com/CodeByMrFinchum/OptimaLab35) is UI for [optima35](https://gitlab.com/CodeByMrFinchum/optima35), currently in heavy development. ## Overview -**OPTIMA-35** (**Organizing, Processing, Tweaking Images, and Modifying scanned Analogs from 35mm Film**) is a Python-based project designed to streamline the management and editing of metadata and images from analog photography. While it was created with analog photography in mind, it is versatile enough to handle any type of images. +**OPTIMA35** (**Organizing, Processing, Tweaking Images, and Modifying scanned Analogs from 35mm Film**) is a Python-based project designed to streamline the management and editing of metadata and images from analog photography. While it was created with analog photography in mind, it is versatile enough to handle any type of images. ## Current Status +### Installation +install via pip and all dependencies will be installed (exept simple-term-menu which is used for TUI, but that package is only aviable for linux) +```Bash +pip install OptimaLab35 +``` ### Development and Versioning Notes **OptimaLab35** is currently in an **alpha stage** and under active development. As a result: @@ -18,53 +24,34 @@ While the project follows a semantic versioning structure (major.minor.patch), b **OptimaLab35** supports two modes: **GUI** and **TUI**. - The **GUI** is loaded by default if **PySide6** is available. -- The **TUI** serves as a fallback when **PySide6** is unavailable or can be started explicitly using the `--tui` option with `main.py`. +- The **TUI** serves as a fallback when **PySide6** (PySide6 is a dependency..) is unavailable or can be started explicitly using the `--tui` option with `main.py`. While all features are implemented and functional, the designs of both the GUI and TUI are not yet finalized. Some safety checks are still under development. -### Available Features: - -**Implemented Features:** -- **Image Processing:** - - Resizing - - Renaming with order adjustment - - Grayscale conversion - - Brightness adjustment - - Contrast adjustment -- **EXIF Management:** - - Copy EXIF data - - Add custom EXIF information - - Add GPS data - - Add a date to EXIF - - Remove EXIF -- **Watermarking** +### OptimaLab35 used features from optima35 to: +**Image Processing:** +- Resizing +- Renaming with order adjustment +- Grayscale conversion +- Brightness adjustment +- Contrast adjustment +**EXIF Management:** +- Copy EXIF data +- Add custom EXIF information +- Add GPS data +- Add a date to EXIF +- Remove EXIF +**Watermarking** ### Preview GUI **GUI for OPTIMA-35** with KvArcDark theme on Linux - -**Main windows** - -![main_tab](https://gitlab.com/CodeByMrFinchum/optima-35/-/raw/main/media/main_tab.png){width=40%} - -**Exif tab when opened, settings disabled by default** - -![exif_tab_disabled](https://gitlab.com/CodeByMrFinchum/optima-35/-/raw/main/media/exif_tab_disabled.png){width=40%} - -**Exif tab after enabeling own exif data** - -![exif_tab_enabled](https://gitlab.com/CodeByMrFinchum/optima-35/-/raw/main/media/exif_tab_enabled.png){width=40%} - -**Dialog window to modify exif file without need to open yaml file** - -![exifeditor](https://gitlab.com/CodeByMrFinchum/optima-35/-/raw/main/media/exifeditor.png){width=40%} +OUT OF DATE, comming soon ### Preview TUI **asciinema recording for TUI** - -![demo_gif](https://gitlab.com/CodeByMrFinchum/optima-35/-/raw/main/media/demo_v041.gif) - +OUT OF DATE, comming soon ## Dependencies @@ -75,15 +62,6 @@ While all features are implemented and functional, the designs of both the GUI a - **pyside6**: For the GUI mode. - **simple_term_menu**: For the TUI mode. -### Installing Dependencies - -You can install the dependencies using the requirements file - -Using `pip`: -```bash -pip install -r requirements.txt -``` - # Use of LLMs In the interest of transparency, I disclose that Generative AI (GAI) large language models (LLMs), including OpenAI’s ChatGPT and Ollama models (e.g., OpenCoder and Qwen2.5-coder), have been used to assist in this project.