Update readme
This commit is contained in:
@@ -8,12 +8,14 @@ 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 have a compiler ([Visual Studio](https://visualstudio.microsoft.com/downloads/) - Windows, [clang](https://clang.llvm.org/get_started.html) + [deps](https://github.com/armory3d/armorpaint/wiki/Linux-Dependencies) - Linux, [Xcode](https://developer.apple.com/xcode/resources/) - macOS / iOS, [Android Studio](https://developer.android.com/studio) - Android), [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
|
||||
```
|
||||
|
||||
**Windows**
|
||||
```bash
|
||||
# Windows
|
||||
node armorcore/make -g direct3d11
|
||||
cd armorcore
|
||||
# Unpack `v8\libraries\win32\release\v8_monolith.7z` using 7-Zip - Extract Here (exceeds 100MB)
|
||||
@@ -23,8 +25,9 @@ node Kinc/make -g direct3d11
|
||||
# Set `Project - Properties - Debugging - Command Arguments` to `..\..\build\krom`
|
||||
# Build for x64 & release
|
||||
```
|
||||
|
||||
**Linux**
|
||||
```bash
|
||||
# Linux
|
||||
node armorcore/make -g opengl
|
||||
cd armorcore
|
||||
node Kinc/make -g opengl --compiler clang --compile
|
||||
@@ -32,8 +35,9 @@ cd Deployment
|
||||
strip Krom
|
||||
./Krom ../../build/krom
|
||||
```
|
||||
|
||||
**macOS**
|
||||
```bash
|
||||
# macOS
|
||||
node armorcore/make -g metal
|
||||
cp -a build/krom/ armorcore/Deployment
|
||||
cd armorcore
|
||||
@@ -42,8 +46,9 @@ node Kinc/make -g metal
|
||||
# Open generated Xcode project
|
||||
# Build
|
||||
```
|
||||
|
||||
**Android** *wip*
|
||||
```bash
|
||||
# Android - wip
|
||||
node armorcore/make android -g opengl --shaderversion 300
|
||||
cp -r build/krom/ armorcore/build/Krom/app/src/main/assets/
|
||||
cd armorcore
|
||||
@@ -53,8 +58,9 @@ node Kinc/make android -g opengl
|
||||
# Open generated Android Studio project
|
||||
# Build for device
|
||||
```
|
||||
|
||||
**iOS** *wip*
|
||||
```bash
|
||||
# iOS - wip
|
||||
node armorcore/make ios -g metal
|
||||
cp -a build/krom/ armorcore/Deployment
|
||||
cd armorcore
|
||||
@@ -64,8 +70,9 @@ node Kinc/make ios -g metal
|
||||
# Open generated Xcode project
|
||||
# Build for device
|
||||
```
|
||||
|
||||
**Windows DXR** *wip*
|
||||
```bash
|
||||
# Windows DXR - wip
|
||||
node armorcore/make -g direct3d12
|
||||
cd armorcore
|
||||
# Unpack `v8\libraries\win32\release\v8_monolith.7z` using 7-Zip - Extract Here (exceeds 100MB)
|
||||
@@ -77,8 +84,9 @@ node Kinc/make -g direct3d12 --raytrace dxr
|
||||
# Set `Project - Properties - Debugging - Command Arguments` to `..\..\build\krom`
|
||||
# Build for x64 & release
|
||||
```
|
||||
|
||||
**Linux VKRT** *wip*
|
||||
```bash
|
||||
# Linux VKRT - wip
|
||||
node armorcore/make -g vulkan
|
||||
cd armorcore
|
||||
git apply patch/vulkan_raytrace.diff --directory=Kinc
|
||||
@@ -88,8 +96,9 @@ cd Deployment
|
||||
strip Krom
|
||||
./Krom ../../build/krom
|
||||
```
|
||||
|
||||
**Windows VR** *wip*
|
||||
```bash
|
||||
# Windows VR - wip
|
||||
node armorcore/make -g direct3d11 --vr oculus
|
||||
cd armorcore
|
||||
# Unpack `v8\libraries\win32\release\v8_monolith.7z` using 7-Zip - Extract Here (exceeds 100MB)
|
||||
@@ -99,14 +108,16 @@ node Kinc/make -g direct3d11 --vr oculus
|
||||
# Set `Project - Properties - Debugging - Command Arguments` to `..\..\build\krom`
|
||||
# Build for x64 & release
|
||||
```
|
||||
|
||||
**Updating cloned repository**
|
||||
```bash
|
||||
# Updating cloned repository
|
||||
git pull origin master
|
||||
git submodule update --init --recursive
|
||||
# Delete `armorpaint/build` directory if present
|
||||
```
|
||||
|
||||
**How to generate or update a locale file**
|
||||
```bash
|
||||
# How to generate or update a locale file
|
||||
pip install typing_extensions -t Assets/locale/tools
|
||||
python ./Assets/locale/tools/extract_locales.py <locale code>
|
||||
# Generated or updated in `Assets/locale/<locale code>.json`
|
||||
|
||||
Reference in New Issue
Block a user