Add docs for development on macOS
This commit is contained in:
@@ -42,12 +42,13 @@ Flax Visual Studio extension provides better programming workflow, C# scripts de
|
|||||||
* Compile Flax project (hit F7 or CTRL+Shift+B)
|
* Compile Flax project (hit F7 or CTRL+Shift+B)
|
||||||
* Run Flax (hit F5 key)
|
* Run Flax (hit F5 key)
|
||||||
|
|
||||||
> When building on Windows to support Vulkan rendering, first install the Vulkan SDK then set an environment variable to provide the path to the SDK prior to running GenerateProjectFiles.bat: `set VULKAN_SDK=C:\VulkanSDK\version\`
|
> When building on Windows to support Vulkan rendering, first install the Vulkan SDK then set an environment variable to provide the path to the SDK prior to running GenerateProjectFiles.bat: `set VULKAN_SDK=%sdk_path%`
|
||||||
|
|
||||||
## Linux
|
## Linux
|
||||||
|
|
||||||
* Install Visual Studio Code
|
* Install Visual Studio Code
|
||||||
* Install Mono ([https://www.mono-project.com/download/stable](https://www.mono-project.com/download/stable))
|
* Install Mono ([https://www.mono-project.com/download/stable](https://www.mono-project.com/download/stable))
|
||||||
|
* Install Vulkan SDK ([https://vulkan.lunarg.com/](https://vulkan.lunarg.com/))
|
||||||
* Install Git with LFS
|
* Install Git with LFS
|
||||||
* Install requried packages: `sudo apt-get install libx11-dev libxcursor-dev libxinerama-dev nuget autoconf libogg-dev automake build-essential gettext cmake python libtool libtool-bin libpulse-dev libasound2-dev libjack-dev portaudio19-dev`
|
* Install requried packages: `sudo apt-get install libx11-dev libxcursor-dev libxinerama-dev nuget autoconf libogg-dev automake build-essential gettext cmake python libtool libtool-bin libpulse-dev libasound2-dev libjack-dev portaudio19-dev`
|
||||||
* Install compiler `sudo apt-get install clang lldb lld` (Clang 6 or newer)
|
* Install compiler `sudo apt-get install clang lldb lld` (Clang 6 or newer)
|
||||||
@@ -56,6 +57,16 @@ Flax Visual Studio extension provides better programming workflow, C# scripts de
|
|||||||
* Open workspace with Visual Code
|
* Open workspace with Visual Code
|
||||||
* Build and run (configuration and task named `Flax|Editor.Linux.Development|x64`)
|
* Build and run (configuration and task named `Flax|Editor.Linux.Development|x64`)
|
||||||
|
|
||||||
|
## Mac
|
||||||
|
|
||||||
|
* Install XCode
|
||||||
|
* Install Mono ([https://www.mono-project.com/download/stable](https://www.mono-project.com/download/stable))
|
||||||
|
* Install Vulkan SDK ([https://vulkan.lunarg.com/](https://vulkan.lunarg.com/))
|
||||||
|
* Clone repo (with LFS)
|
||||||
|
* Run `GenerateProjectFiles.command`
|
||||||
|
* Open workspace with XCode or Visual Studio Code
|
||||||
|
* Build and run (configuration `Editor.Mac.Development`)
|
||||||
|
|
||||||
## Workspace directory
|
## Workspace directory
|
||||||
|
|
||||||
- **Binaries/** - executable files
|
- **Binaries/** - executable files
|
||||||
|
|||||||
Reference in New Issue
Block a user