readme

README.md

@@ -0,0 +1,76 @@
+# MayoStainHelper
+
+## Opis Projektu
+
+**MayoStainHelper** to aplikacja wspierająca rzemieślników zajmujących się nakładaniem bejcy na gitary. Głównym celem projektu jest eliminacja zawodności ludzkiego oka w ocenie subtelnych różnic kolorystycznych, co prowadzi do uzyskania perfekcyjnej powtarzalności barw. Dzięki temu rozwiązaniu nawet najbardziej skomplikowane i wieloetapowe procesy bejcowania stają się przewidywalne, a finalny produkt spełnia najwyższe standardy jakości.
+
+Aplikacja jest zaprojektowana tak, aby była intuicyjna i prosta w obsłudze, nawet dla osób bez specjalistycznej wiedzy na temat fotografii czy przetwarzania obrazu.
+
+---
+
+## Kluczowe Funkcje
+
+- **Podgląd na żywo z kamery**  
+    Aplikacja wyświetla obraz w czasie rzeczywistym z podłączonego aparatu, umożliwiając bieżące monitorowanie procesu nakładania koloru.
+
+- **Porównanie w czasie rzeczywistym**  
+    Możliwość nałożenia obrazu referencyjnego na podgląd na żywo z kamery, co ułatwia natychmiastowe porównanie i weryfikację koloru.
+
+- **Łatwa kalibracja kolorów**  
+    Użytkownik może w prosty sposób skalibrować obraz z aparatu oraz wyświetlany na ekranie, używając karty SpyderChecker 24. Zapewnia to, że kolory widziane w aplikacji są zawsze wiarygodne.
+
+- **Wspomaganie ekspozycji**  
+    Aplikacja wyświetla histogram na bieżąco, pomagając użytkownikowi w optymalnym ustawieniu parametrów aparatu (ISO, przesłona, czas naświetlania).
+
+- **Baza kolorów**  
+    Aplikacja przechowuje bazę referencyjnych zdjęć i filmów, zorganizowaną według modeli gitar. Pozwala to na szybki dostęp do odpowiednich wzorców.
+
+- **Rejestrowanie mediów**  
+    Możliwość robienia zdjęć oraz nagrywania wideo, które można dodać do bazy kolorów. Jest to przydatne, gdy dany proces bejcowania wymaga uwiecznienia poszczególnych etapów.
+
+---
+
+## Wymagania Systemowe
+
+Projekt jest pisany w języku Python i projektowany z myślą o kompatybilności z różnymi systemami operacyjnymi:
+
+- **Systemy operacyjne:**  
+    macOS (docelowy), Windows, Linux
+
+- **Sprzęt:**  
+    - Podłączony aparat cyfrowy, kompatybilny z biblioteką gphoto2 (np. Canon 550D)  
+    - Karta kalibracyjna SpyderChecker 24
+
+---
+
+## Technologia
+
+Projekt wykorzystuje następujące biblioteki i technologie:
+
+- **Python** – język programowania
+- **PySide6** – do tworzenia interfejsu graficznego (GUI)
+- **pygphoto2** (wymaga gphoto2) – do komunikacji z aparatem
+- **OpenCV** – do przetwarzania obrazu i kalibracji kolorów
+- **SQLite** – do zarządzania bazą danych kolorów
+- **Matplotlib & NumPy** – (potencjalnie) do analizy i wizualizacji danych
+
+---
+
+## Instalacja
+
+> Szczegółowe instrukcje instalacji zostaną dodane w przyszłości. Przykładowe kroki:
+
+1. Sklonuj repozytorium:  
+     `git clone https://github.com/twoja_nazwa_uzytkownika/MayoStainHelper.git`
+2. Przejdź do katalogu projektu:  
+     `cd MayoStainHelper`
+3. Zainstaluj zależności:  
+     `pip install -r requirements.txt`
+4. Uruchom aplikację:  
+     `python main.py`
+
+---
+
+## Licencja
+
+Projekt jest prywatny i przeznaczony do użytku wewnętrznego firmy.