Merge branch 'main' of github.com:Frank-py/ChessQLD

README.md

@@ -6,44 +6,87 @@ ChessQD, developed by Frank Hans and Wertzuz, is an implementation of the ancien
 
 ## Features
 
--     Graphical User Interface
--     In-game accessible buttons:
-  -     Rotate Board
-  -     Play Online
-    -     Play against another person on the local network
-  -     Resign
+- Graphical User Interface
+- In-game accessible buttons:
+  - Rotate Board
+  - Play Online
+    - Play against another person on the local network
+  - Resign
     End the current game
--     Display of the game result
--     Timer display
--     Variable resolution and window size
--     Implementation of the Chess board game following official rules
+- Display of the game result
+- Timer display
+- Variable resolution and window size
+- Implementation of the Chess board game following official rules
+
+
+## Prerequisites Running
+
+Before running or building ChessQD, make sure you have the following libraries installed on your system:
+
+### For Running ChessQD:
+
+- libsdl2-2.0-0
+- libsdl2-image-2.0-0
+- libsdl2-ttf-2.0-0
+
+### Installing Required Libraries
+
+To install the libraries(on Ubuntu) needed for running ChessQD, open a terminal and run the following command:
+
+```bash
+sudo apt-get install libsdl2-2.0-0 libsdl2-image-2.0-0 libsdl2-ttf-2.0-0
+```
 
 ## Installation (Release Version)
 
 To install the release version of ChessQD, follow these steps:
 
-1.      Visit the [Releases](https://github.com/Hckerx/ChessQD/releases) section of our GitHub repository.
+1. Visit the [Releases](https://github.com/Hckerx/ChessQD/releases) section of our GitHub repository.
+
+2. Download the latest release exe file or ELF file from the available assets.
+
+3. Run the file from the bin directory or make sure that it had access to the subfolders font/ and gfx/
+
+
+## Prerequisites Building
+
+### For Building ChessQD:
+
+- libboost-all-dev
+- libsdl2-image-dev
+- libsdl2-ttf-dev
+- libsdl2-dev
+- libasio-dev
+- libglm-dev
+
+
+For building ChessQD, use the following command to install the necessary development libraries:
+
+```bash
+sudo apt-get install libboost-all-dev libsdl2-image-dev libsdl2-ttf-dev libsdl2-dev libasio-dev
+```
+
+## Building ChessQD
 
-2.      Download the latest release exe file or ELF file from the available assets.
+After installing the required libraries, you can build ChessQD by executing the following commands in the terminal:
 
-3.      Run the file
+```bash
+# Navigate to the directory containing ChessQD
+cd /path/to/chessqd
 
-## Build instructions
+# build
+make build
+```
 
-    ```shell
-git clone https://github.com/Hckerx/ChessQD.git
-//FIXME install dependencies
-make #to build and run or alternatively make build just to build
-    ```
 
 ## Future Enhancements
 
 In future versions, we plan to:
 
--     Enhance the online mode
--     Add PGN-Notation
--     Add a time limit feature
--     Implement new features based on user feedback.
+- Enhance the online mode
+- Add PGN-Notation
+- Add a time limit feature
+- Implement new features based on user feedback.
 
 ## Contributing