Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Frank Hans <85338377+Frank-py@users.noreply.github.com>
  • Loading branch information
Frank-py authored Dec 9, 2023
1 parent d36bef2 commit 62ac91c
Showing 1 changed file with 49 additions and 7 deletions.
56 changes: 49 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,25 @@ ChessQD, developed by Frank Hans and Wertzuz, is an implementation of the ancien
- 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:
Expand All @@ -26,15 +45,38 @@ To install the release version of ChessQD, follow these steps:

2. Download the latest release exe file or ELF file from the available assets.

3. Run the file
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


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

After installing the required libraries, you can build ChessQD by executing the following commands in the terminal:

```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

Expand Down

0 comments on commit 62ac91c

Please sign in to comment.