summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/usage.asciidoc21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/usage.asciidoc b/docs/usage.asciidoc
new file mode 100644
index 0000000..b3f4c4b
--- /dev/null
+++ b/docs/usage.asciidoc
@@ -0,0 +1,21 @@
+= Usage
+
+Basic usage
+-----------
+- Select the folder that contains your love-source, press `Select project dir`.
+- Press `Compile` or `Ctrl + Shift + F5`.
+- The app should now compile, a output-window will open and show status of the process.
+- It will try to install it on any connected android-phone.
+
+AndroidManifest and Custom Icon
+--------------------------------
+If you want to change settings of the app, press the `dirs`-button. Go to `tools\love-android-sdl2\` copy the file 'AndroidManifest.xml` into you project directory. And edit the file in you project-dir
+
+I have not implemented a custom-icon possibility yet. You could change it in the `tools\love-android-sdl2` dir, but this would affect all apps.
+
+Settings
+--------
+There are two options in the settings of the app itself.
+
+- `Window always on top` - This makes the app always stay on top of other apps... `[Default: No]`
+- `Close output-window if build was successfull` - This closes the output-window if it thinks the build was successfull, this option assumes that the compilation succeded. And it does not care if it was able to push to your phone. `[Default: No]`