diff --git a/README.md b/README.md index 6717984..24c56d1 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,22 @@ -# OPTIMA-35 +# OptimaLab35 +UI for [OPTIMA35](https://gitlab.com/CodeByMrFinchum/optima-35) package, WIP. ## 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. -This project replaces my earlier [analogphotography](https://gitlab.com/sf-bashscripts/analogphotography) bash script collection, which has now been archived in favor of OPTIMA-35. - -**OPTIMA-35** is a cross-platform program. The **GUI** works on Linux and Windows(1) and is expected to run on macOS. The **TUI** is currently Linux-only, as its dependency is exclusive to Linux. - -(1): Windows' default image viewer has limitations in displaying some EXIF metadata. Use dedicated software for full EXIF data visibility. - ## Current Status ### Development and Versioning Notes -**OPTIMA-35** is currently in an **alpha stage** and under active development. As a result: -- The README may occasionally be outdated. -- Users are encouraged to check for new branches and read the [**CHANGELOG**](https://gitlab.com/CodeByMrFinchum/optima-35/-/blob/main/CHANGELOG.md?ref_type=heads), which is consistently updated and well-documented. -- Bugs or unforeseen behavior may occur. +**OptimaLab35** is currently in an **alpha stage** and under active development. As a result: +- The README may occasionally be outdated. +- Users are encouraged to check for new branches and read the Changelog +- Bugs or unforeseen behavior may occur. While the project follows a semantic versioning structure (major.minor.patch), breaking changes—typically reserved for major version increments—may also occur in minor version updates during this development phase. Please review the changelog carefully before updating. -**OPTIMA-35** supports two modes: **GUI** and **TUI**. +**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`. @@ -76,24 +71,17 @@ While all features are implemented and functional, the designs of both the GUI a **OPTIMA-35** has two modes: **GUI** and **TUI**. Each mode has its own set of dependencies, so you don’t need to install TUI dependencies if you only plan to use the GUI (and vice versa). **Required Dependencies:** -- **pyyaml**: For handling YAML files (configuration and settings). -- **piexif**: For reading, modifying, and writing EXIF metadata. -- **pillow**: For image processing. +- **optima35** - **pyside6**: For the GUI mode. - **simple_term_menu**: For the TUI mode. ### Installing Dependencies -You can install the dependencies using the respective requirements file for your desired mode (**TUI** or **GUI**). +You can install the dependencies using the requirements file Using `pip`: ```bash -pip install -r requirements_gui.txt -``` - -Alternatively, if you use **conda** or its alternatives (**anaconda**, **mamba**, **micromamba**), run: -```bash -conda install -c conda-forge --file requirements_gui.txt +pip install -r requirements.txt ``` # Use of LLMs