Update readme

2019-05-26 12:30:39 +02:00
parent bb80421583
commit be9fa5dbf3
1 changed files with 37 additions and 3 deletions
@@ -9,6 +9,40 @@ armorpaint

 *Note 1: This repository is aimed at developers and may not be stable. Distributed binaries are currently [paid](https://armorpaint.org/download) to help with the project funding. All of the development is happening here in order to make it accessible to everyone. Thank you for support!*

-*Note 2: If you are compiling git version of ArmorPaint, then you need to [download Armory](https://armory3d.org/download.html) and update it to the latest [git version](https://armory3d.org/manual/#/dev/gitversion?id=armory-updater). Afterwards, clone this repository using `git clone https://github.com/armory3d/armorpaint` and open the `armorpaint.blend` file in Armory. On Windows, set `Blender Preferences - Add-ons - Armory - Player Graphics API` to `OpenGL`. Press `Armory Player - Play` (F5) to run.*
-
-*Note 3: To enable Direct3D11 support (Windows) and native file dialogs (Windows, Linux, macOS), compile Krom located [here](https://github.com/armory3d/Krom_armorpaint) and replace your copy at `Armory/armsdk/Krom`.* For debugging instructions, see [docs](https://armory3d.org/manual/#/essentials/debug).
+*Note 2: If you are compiling git version of ArmorPaint, then you need to have a compiler ([Visual Studio](https://visualstudio.microsoft.com/downloads/) - Windows, [clang](https://clang.llvm.org/get_started.html) - Linux, [Xcode](https://developer.apple.com/xcode/resources/) - macOS), [nodejs](https://nodejs.org/en/download/) and [git](https://git-scm.com/downloads) installed.*
+```bash
+git clone --recursive https://github.com/armory3d/armorpaint
+cd armorpaint
+```
+```bash
+# Windows
+node Kha/make krom -g direct3d11
+cd Krom
+node Kore/make -g direct3d11
+# Open generated Visual Studio project
+# Set command-line arguments to `..\..\build\krom`
+# Build for x64 & release
+```
+```bash
+# Linux
+node Kha/make krom -g opengl
+cd Krom
+node Kore/make -g opengl --compiler clang --compile
+cp build/Release/Krom Deployment/Krom
+cd Deployment
+strip Krom
+./Krom ../../build/krom
+```
+```bash
+# macOS
+node Kha/make krom -g opengl
+cd Krom
+node Kore/make -g opengl
+# Open generated Xcode project
+# Set command-line arguments to `armorpaint_repo/build/krom`
+# Build
+```
+```bash
+# Optional: Parse krom.js bytecode into krom.bin for startup efficiency
+./Krom_binary armorpaint_repo/build/krom armorpaint_repo/build/krom-resources --writebin
+```