init

sample/README.md

@@ -0,0 +1,43 @@
+# Projekt Kalkulator PHP
+
+## Opis
+
+Projekt Kalkulatora PHP to prosta aplikacja konsolowa napisana w PHP, która pozwala na wykonanie podstawowych operacji matematycznych takich jak dodawanie. Projekt został skonfigurowany do uruchamiania w środowisku Docker, co ułatwia zarządzanie zależnościami i zapewnia spójne środowisko uruchomieniowe.
+
+## Wymagania
+
+- Docker
+- Docker Compose
+
+## Uruchamianie aplikacji
+
+Aby uruchomić aplikację, skorzystaj z poniższych kroków:
+
+1. Zbuduj obraz Docker:
+
+    ```bash
+    docker compose build
+    ```
+
+2. Uruchom aplikację z przekazaniem dwóch liczb jako argumentów:
+
+    ```bash
+    docker compose run app php index.php 2 3
+    ```
+
+    Powyższe polecenie wykona operację dodawania na liczbach 2 i 3.
+
+## Uruchamianie testów
+
+Aby uruchomić testy jednostkowe, użyj poniższego polecenia:
+
+```bash
+docker compose run app php ./vendor/bin/phpunit tests/
+```
+
+## Sprawdzenie PHPCS
+
+By sprawdzić, czy kod jest poprawny względem phpcs należy uruchomić:
+```
+docker compose run app vendor/bin/phpcs --standard=PSR12 src
+```