Skip to content

Commit

Permalink
Updated the README regarding vcpkg integration.
Browse files Browse the repository at this point in the history
  • Loading branch information
DorianBDev committed Nov 25, 2024
1 parent b707923 commit 7163404
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,15 +126,16 @@ Also, you can find [here](https://github.com/DegateCommunity/Degate/wiki) the of

## Dependencies

Degate has only 2 dependencies: Boost and Qt5.
Degate has only 2 dependencies: Boost and Qt6.

We use [vcpkg](https://vcpkg.io) to handle installation of those, please refer to the #Quick-start section below.

## Dependencies version
## Dependencies list

- CMake 3.12.0 or newer,
- *(optional)* Qt 6.2.4 or newer,

For Linux (please read the Linux section below):
For Linux (please read the Linux section below, some dependencies are only needed if using VCPKG's Qt):
- xcb-lib
- xrender-lib
- autoconf
Expand All @@ -158,22 +159,24 @@ First, clone this repository (help [here](https://docs.github.com/en/github/crea

### For Linux (debian-like)

Prepare the install of dependencies:
Prepare the install of dependencies (some of them are only needed if using VCPKG's Qt):
```console
> ./vcpkg/bootstrap-vcpkg.sh -disableMetrics
> apt install '^libxcb.*-dev' libx11-xcb-dev libglu1-mesa-dev libxrender-dev libxi-dev libxkbcommon-dev
libxkbcommon-x11-dev libegl1-mesa-dev
> apt install libxi-dev libgl1-mesa-dev libglu1-mesa-dev mesa-common-dev libxrandr-dev libxxf86vm-dev autoconf autoconf-archive
libxkbcommon-x11-dev libegl1-mesa-dev libglu1-mesa-dev mesa-common-dev libxrandr-dev libxxf86vm-dev
autoconf autoconf-archive
```
If anything is missing, you should be prompted with help on how to install the needed tools.

Build (in the 'build' folder, for example):
```console
> cmake ..
> cmake .. -DVCPKG_QT=1
> make
```
Binaries are in the 'build/out/bin' folder.

If you prefer to use your local Qt installation (and to avoid rebuilding Qt through VCPKG) please use the `-DVCPKG_QT=0` option.

### For Windows

Install dependencies:
Expand All @@ -185,12 +188,14 @@ Install dependencies:

Build (in the 'build' folder, for example):
```console
> cmake ..
> cmake .. -DVCPKG_QT=1
> cmake --build .
```

Binaries are in the 'build/out/bin' folder.

If you prefer to use your local Qt installation (and to avoid rebuilding Qt through VCPKG) please use the `-DVCPKG_QT=0` option.

### For MacOS

Prepare the install of dependencies:
Expand All @@ -201,12 +206,14 @@ Prepare the install of dependencies:

Build (in the 'build' folder, for example):
```console
> cmake ..
> cmake .. -DVCPKG_QT=1
> cmake --build .
```

Binaries are in the 'build/out/bin' folder in the bundle ".app" format.

If you prefer to use your local Qt installation (and to avoid rebuilding Qt through VCPKG) please use the `-DVCPKG_QT=0` option.

## Troubleshooting

- `Could NOT find Boost (missing: filesystem system thread) (found version "1.71.0")`
Expand Down

0 comments on commit 7163404

Please sign in to comment.