From 533bc572326b2354ca8b7d53a4970957029e8425 Mon Sep 17 00:00:00 2001 From: cediackermann Date: Mon, 27 Jan 2025 14:37:32 +0100 Subject: [PATCH] update README.md --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ae1a1b1..1fe0d83 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,25 @@ # syncaud +## Requirements + +- [At least one custom exception class that extends Exception should be written.](./src/client_handler.rs#L6) (The struct `BindError` is a custom exception, which defines the error type for binding errors.) +- [At least one inheritance implementation must be included.](./src/client_handler.rs#L37) (The `NetworkListener` implements the `ClientHandler` and `Listener` trait.) +- [At least one custom (non-Spring Boot interface) interface should be created and used.](./src/client_handler.rs#14) (The `ClientHandler` trait is like an interface in Rust.) + +## Design Pattern + +We adhered to the YAGNI (You Ain’t Gonna Need It) principle throughout the development process to avoid unnecessary complexity and over-engineering. By focusing only on features and functionality that were essential to the immediate requirements, we streamlined our implementation and kept the codebase lean. This approach not only reduced development time and effort but also ensured that the code was easier to maintain, understand, and optimize. As a result, we achieved maximum efficiency while maintaining a minimal and effective code structure tailored to meet the project’s specific needs. + ## Featurelist + - The user interface should be interactive and usable by any person. - Sounds are played synchronously across multiple devices. - Any mp3 file can be uploaded by the user to play. ## Planned structure + ![syncaud(1)](https://github.com/user-attachments/assets/264a3af8-717f-43ed-9c51-2d1da54b8c8a) - ## Actual structure -!![Syncaud](https://github.com/user-attachments/assets/97cc57de-a53d-48e3-b09e-8057bba05bac) + +![Syncaud](https://github.com/user-attachments/assets/97cc57de-a53d-48e3-b09e-8057bba05bac)