Skip to content

Commit

Permalink
Update BUILDING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
exjam committed Dec 20, 2019
1 parent 2d27e24 commit 3ad974c
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions BUILDING.md
Expand Up @@ -31,15 +31,17 @@ By default conan will use `%USERPROFILE%/.conan`, if you have limited C:/ drive
Required:
- A modern C++17 friendly compiler such as g++8
- CMake
- c-ares
- libcurl
- libuv
- openssl
- sdl2
- zlib

Optional:
- ffmpeg, disable by using `-DDECAF_FFMPEG=OFF`
- [Vulkan SDK](https://vulkan.lunarg.com/sdk/home#windows), disable by using `-DDECAF_VULKAN=OFF`
- Qt
- Qt, disable by using `-DDECAF_QT=OFF`

The dependencies, other than Vulkan, can either be acquired using your package manager such as:
- Required: `apt install cmake libcurl4-openssl-dev libsdl2-dev libssl-dev zlib1g-dev`
Expand All @@ -61,7 +63,7 @@ You may choose to use a mix of system dependenices such as if your system's ffmp
- `mkdir build`
- `cd build`
- If using conan: `conan install .. -o silent=True -o curl=False -o openssl=False`
- `cmake -DCMAKE_BUILD_TYPE=Release -DDECAF_QT=ON ../`
- `cmake -DCMAKE_BUILD_TYPE=Release ../`
- `make`

## MacOS
Expand Down Expand Up @@ -96,4 +98,6 @@ Options interesting to developers:

## Troubleshooting

decaf-emu builds on github actions CI - so a good reference on how to build is always the CI script itself [.github/workflows/ccpp.yml](https://github.com/decaf-emu/decaf-emu/blob/master/.github/workflows/ccpp.yml)

Often conan requires updating to the latest version to fix various issues, so if it is failing to install dependencies then be sure to `pip install --upgrade conan` / `brew upgrade conan` / update conan manually.

0 comments on commit 3ad974c

Please sign in to comment.