Skip to content

building.md

Latest commit

 

History

History
39 lines (20 loc) · 2.37 KB

building.md

File metadata and controls

39 lines (20 loc) · 2.37 KB

Building

General

If you want to modify the shader parsers of the graphics library frontends you will need to modify the *.l and *.y files and compile them back to the *.cpp files with Flex and Bison respectively.

If you want to modify the shaders used by the ui library you will need to modify the *.glsl files and compile them to *.spv binaries using Glslang. Choose the proper shader type based on the filename suffix.

Platforms

Below are the instructions to compile Nucleus for different platforms. If you want to cross-compile Nucleus, which is particularly relevant for mobile targets, details for each host compiling platform are provided as well.

Windows

  • Compiling on Windows: Install Visual Studio 2015. Open nucleus.sln and build the project nucleus-windows. Alternatively, if you have the Windows 10 SDK installed you can compile the Universal Windows Platform wrapper by building the project nucleus-uwp.

Windows Phone

Linux

  • Compiling on Linux: Follow the .travis.yml file.

Android

  • Compiling on Windows: Install Visual Studio 2015 along with the Android SDK and Android NDK. Open nucleus.sln and build the project nucleus-android.

  • Compiling on Linux: TODO.

  • Compiling on OS X: TODO.

iOS

  • Compiling on Windows: Install Visual Studio 2015. Install OS X in a virtual machine, e.g. via VirtualBox, and ensure that both your host and virtual machine share a network. Install Xcode on the virtual machine. [...]. On your host machine, open nucleus.sln and build the project nucleus-ios. Observe how nothing works. Cry.

  • Compiling on OS X: Buy a Mac. Cry.