Skip to content

Commit 6a97b94

Browse files
committed
docs: add deploy chapter
1 parent 76c1c61 commit 6a97b94

File tree

5 files changed

+101
-0
lines changed

5 files changed

+101
-0
lines changed

docs/deploying/android.rst

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
====================
2+
Deploying to Android
3+
====================
4+
5+
Install Java JDK
6+
----------------
7+
8+
1. Install the latest JDK:
9+
10+
* https://www.oracle.com/java/technologies/downloads/
11+
12+
2. Set JAVA_HOME environment variable, if the JDK installer did not:
13+
14+
.. code::
15+
16+
export JAVA_HOME=<java_jdk>
17+
18+
Install Android SDK & NDK
19+
-------------------------
20+
21+
1. Install sdkmanager:
22+
23+
* https://developer.android.com/tools/sdkmanager
24+
25+
2. Install Android SDK, NDK and tools:
26+
27+
.. code::
28+
29+
<android_sdk>/latest/cmdline-tools/sdkmanager \
30+
"platforms;android-33" \
31+
"ndk;27.2.12479018" \
32+
"platform-tools" \
33+
"build-tools;34.0.0"
34+
35+
build-tools >= 34.0.0 is required.
36+
37+
Set environment variables
38+
-------------------------
39+
40+
.. code::
41+
42+
export ANDROID_SDK_PATH=<android_sdk>
43+
export ANDROID_API_LEVEL=33
44+
export ANDROID_NDK_ROOT=<android_ndk>
45+
export ANDROID_NDK_ABI=24
46+
export ANDROID_BUILD_TOOLS=<android_build-tools>/34.0.0
47+
48+
Generate a keystore
49+
-------------------
50+
51+
.. code::
52+
53+
keytool -genkey -v -keystore test.keystore -alias test \
54+
-keyalg RSA -keysize 2048 -validity 10000 \
55+
-keypass 123456 -storepass 123456

docs/deploying/desktop.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
==============================
2+
Deploying to Desktop Platforms
3+
==============================
4+
5+
Deploying to desktop platforms do not require any configuration.
6+
7+
Cross-compiling for a Desktop Platform different than the one Crown is running
8+
on is currently not supported.

docs/deploying/html5.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
==================
2+
Deploying to HTML5
3+
==================
4+
5+
Install emscripten
6+
------------------
7+
8+
Install emscripten:
9+
10+
* https://emscripten.org/docs/getting_started/downloads.html
11+
12+
Set environment variables
13+
-------------------------
14+
15+
.. code::
16+
17+
export EMSCRIPTEN=<emsdk>/upstream/emscripten
18+
19+
Running the generated output
20+
----------------------------
21+
22+
Use `emrun` to run the generated `index.html`:
23+
24+
.. code::
25+
26+
cd <output_dir>
27+
<emsdk>/upstream/emscripten/emrun index.html

docs/deploying/index.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
=========
2+
Deploying
3+
=========
4+
5+
.. toctree::
6+
:maxdepth: 2
7+
8+
android
9+
html5
10+
desktop

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Crown |version| Manual
88
introduction
99
installing_crown/index
1010
getting_started/index
11+
deploying/index
1112
reference/index
1213
lua_api
1314
glossary

0 commit comments

Comments
 (0)