From 714a4bbceb2692ad4a23450b23465482b0f3343b Mon Sep 17 00:00:00 2001 From: Jason <154414066+bou-samra@users.noreply.github.com> Date: Mon, 11 May 2026 18:38:53 +1000 Subject: [PATCH] Update README.md --- README.md | 44 ++++++++++++++++++++++++++++++-------------- 1 file changed, 30 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 198958d..65080e0 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,42 @@ -# complete-system -Amiga complete system demo +# Amiga Complete System Demo -## Change-log: +**Author:** Jason Bou-Samra (Paragon) -2023-02 -* Initial release +A nostalgic, hardware-accelerated image viewer written in **Ada** using the **SDL2** (Simple DirectMedia Layer) bindings. This project serves as a demonstration of window initialization and texture rendering on modern systems while paying homage to the Amiga era. -## Compilation +--- -`gprbuild -largs $(pkg-config sdl2 SDL2_image --libs)` +## 🚀 Features +* **Hardware Acceleration:** Utilizes SDL2's `Accelerated` renderer flags. +* **V-Sync Support:** Includes `Present_V_Sync` to ensure smooth, tear-free image display. +* **Asset Loading:** Leverages `SDL_image` to handle PNG file formats. +* **Event Handling:** A dedicated event loop captures the `Quit` signal to close the window gracefully. +* **Nostalgia:** Specifically designed to showcase Amiga-themed graphical assets. -## Screenshot +--- + +## 📸 Screenshot ![Complete System](https://github.com/bou-samra/complete-system/blob/main/img/AmigaSys.ilbm.png) -## Misc. +--- -* A bit of nostalgia +## 🛠 Prerequisites -## Todo +To compile and run this program, you will need: +1. **GNAT Compiler** (e.g., GNAT Community or FSF GNAT). +2. **SDL2 Libraries:** `SDL2` and `SDL2_image` development packages. +3. **SDLAda Bindings:** The Ada-specific wrappers for SDL2. +4. **pkg-config:** To handle library flags during compilation. -* nothing at this point +--- -## Author(s) -Jason Bou-Samra +## ⚙️ Compilation +The project is configured to be built with `gprbuild`. Use the following command to link the necessary SDL2 libraries: + +```bash +gprbuild -largs $(pkg-config sdl2 SDL2_image --libs) +``` +**Alternatively, using gnatmake:** +```ada +gnatmake main.adb -largs -lSDL2 -lSDL2_image