Built instructions for YSCE

app4soft commented 2 years ago

Expected behavior

Built instruction should include all required info to built under supported platforms (Linux, Mac & Windows).

Actual behavior

Original built instruction does not include platform/OS specific dependencies, as a result compilation fails.

Add instruction for each platform/OS

Linux (Ubuntu 20.04 / Debian 11):

Note Due to latest changes in some Linux distributions compiler used -pie (instead of -no-pie), so all resulted binary might be compiled as x-shared-library (instead of setting x-executable for ysglight64_gl1/ysflight64_gl2/ysflight64_nownd game launchers and x-shared-library for libvoiceYsflight64.so/libsndYsflight64-pulse.so/libsndYsflight64.so plugins)

See: https://github.com/YSCEDC/YSCE/issues/7

Check & Install build dependency packages:
- cmake
- libx11-dev
- libgl-dev
- libglu1-mesa-dev
- libasound2-dev
- libpulse-dev
- python-is-python3 (see https://github.com/captainys/YSFLIGHT/issues/2)

Open terminal in your working directory and do next:

git clone https://github.com/captainys/public.git
git clone https://github.com/YSCCEDC/YSCE.git
cd YSCE
mkdir build
cd build
cmake ../src
cmake --build . --config Release --parallel

Copy contents of ./YSCE/build/main to ~/Documents/YSFLIGHT.COM

Mac:

(TBA)

Windows:

(TBA)

NodokaHanamura commented 2 years ago

We'll probably merge your suggestions in soon, but if you could, provide input on Windows.

NodokaHanamura commented 2 years ago

Since Yamakawa-sensei included build instructions for Windows and MacOS as part of the Repo actions from upstream, I should be able to add Windows and MacOS instructions. I'll see what I can do about adding it later this week if I have time.

YSCEDC / YSCE