diff --git a/README.md b/README.md index 4ef31c91c..3cbcfb6fe 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,7 @@ Flax Visual Studio extension provides better programming workflow, C# scripts de * Install Windows 8.1 SDK or newer (via Visual Studio Installer) * Install Microsoft Visual C++ 2015 v140 toolset or newer (via Visual Studio Installer) * Install .Net Framework 4.5.2 SDK/Targeting Pack (via Visual Studio Installer) +* Install Git with LFS * Clone repo (with LFS) * Run **GenerateProjectFiles.bat** * Open `Flax.sln` and set solution configuration to **Editor.Development** and solution platform to **Win64** @@ -48,12 +49,23 @@ Flax Visual Studio extension provides better programming workflow, C# scripts de ## Linux * Install Visual Studio Code -* 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 Mono + * Ubuntu: see the instructions here: ([https://www.mono-project.com/download/stable](https://www.mono-project.com/download/stable)) + * Arch: `sudo pacman -S mono` +* Install Vulkan SDK + * Ubuntu: see the instructions here: ([https://vulkan.lunarg.com/](https://vulkan.lunarg.com/)) + * Arch: `sudo pacman -S spirv-tools vulkan-headers vulkan-tools vulkan-validation-layers` * 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 compiler `sudo apt-get install clang lldb lld` (Clang 6 or newer) -* Clone repo (with LFS) + * Ubuntu: `sudo apt-get install git git-lfs` + * Arch: `sudo pacman -S git git-lfs` + * `git-lfs install` +* Install the required packages: + * Ubuntu: `sudo apt-get install libx11-dev libxcursor-dev libxinerama-dev zlib1g-dev` + * Arch: `sudo pacman -S base-devel libx11 libxcursor libxinerama zlib` +* Install Clang compiler (version 6 or later): + * Ubuntu: `sudo apt-get install clang lldb lld` + * Arch: `sudo pacman -S clang lldb lld` +* Clone the repository (with LFS) * Run `./GenerateProjectFiles.sh` * Open workspace with Visual Code * Build and run (configuration and task named `Flax|Editor.Linux.Development|x64`)