Browse Source

Update readme.

Miku AuahDark 5 years ago
parent
commit
1fe71865f6
1 changed files with 23 additions and 4 deletions
  1. 23 4
      README.md

+ 23 - 4
README.md

@@ -1,10 +1,32 @@
 Android Port of LÖVE, the awesome 2D game engine LÖVE (http://love2d.org)
 Copyright (c) 2013-2017 Martin Felis <[email protected]>
 
+Important:
+----------
+
+First, make sure to clone the submodules too. This is important. Often errors include missing liblove.so and
+"Missing LOVE. Make sure to initialize the submodule correctly!" error when building. A proper way to clone this
+repository is:
+
+```
+git clone --recurse-submodules https://github.com/love2d/love-android
+```
+
+Add `-b <branch name>` and `--depth 1` if needed.
+
+If you already cloned the repository but forgot to initialize the submodules, execute:
+
+```
+git submodule sync --recursive
+git submodule update --init --force --recursive
+```
+
+In the repository directory. For the last command, add `--depth 1` if needed.
+
 Instructions:
 -------------
 
-For detailed instructions please refer to the wiki at [https://bitbucket.org/MartinFelis/love-android-sdl2/wiki/Home](https://bitbucket.org/MartinFelis/love-android-sdl2/wiki/Home).
+Detailed instructions can be viewed at [https://bitbucket.org/MartinFelis/love-android-sdl2/wiki/Home](https://bitbucket.org/MartinFelis/love-android-sdl2/wiki/Home). (at the moment)
 
 Download:
 ---------
@@ -24,9 +46,6 @@ environment variables:
 
 * `ANDROID_NDK_HOME` to your Android NDK location. NDK r16 or later; r19 also work.
 
-    ndk.dir=/opt/android-ndk
-    sdk.dir=/opt/android-sdk
-
 (you may have to adjust the paths to the install directories of the Android
 SDK and Android NDK on your system) and run