From 2d0084cf87fd58001066caecf10996c3d8e33691 Mon Sep 17 00:00:00 2001 From: Vajda Ervin-Oliver <133162784+Dr20Ervin@users.noreply.github.com> Date: Wed, 27 May 2026 12:09:44 +0300 Subject: [PATCH] Enhance README formatting and add architecture section Updated README to improve formatting and add UML diagram section. --- README.md | 32 ++++++++++++++++++++++++++------ 1 file changed, 26 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d6734f9..9beb56e 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,19 @@ -# 🏓 Pong Reloaded +

+ Pong Reloaded Logo +

-A classic arcade game rebuilt from the ground up using **Modern C++ (C++20)** and the **Raylib** library. Designed with performance, customization, and modularity in mind. +

🏓 Pong Reloaded

-[![C++ Version](https://img.shields.io/badge/Language-C%2B%2B20-blue?logo=c%2B%2B&style=flat-square)](https://en.cppreference.com/w/cpp/compiler_support/20) -[![Raylib](https://img.shields.io/badge/Framework-Raylib--6.0-red?style=flat-square)](https://www.raylib.com/) -[![Platform](https://img.shields.io/badge/Platform-Windows-0078d7?logo=windows&style=flat-square)](https://www.microsoft.com/windows) -[![License](https://img.shields.io/badge/License-MIT-green?style=flat-square)](LICENSE.txt) +

+ A classic arcade game rebuilt from the ground up using Modern C++ (C++20) and the Raylib library. Designed with performance, customization, and modularity in mind. +

+ +

+ C++ Version + Raylib + Platform + License +

--- @@ -38,6 +46,18 @@ The key goals of this project: --- +## 📐 Architecture & System Design + +To ensure modularity, high performance, and clear separation of concerns, **Pong Reloaded** is built around a decoupled Object-Oriented design. + +Below is the UML class diagram outlining the relationships between the game entities, screen controllers, state management, and resource loaders: + +

+ Pong Reloaded UML Diagram +

+ +--- + ## 💾 Quick Install & Play No installers, DLLs, or complex dependency installations are required!