From 1fe71865f6a25d8e0c8049e2298d3b23069099fe Mon Sep 17 00:00:00 2001 From: Miku AuahDark Date: Wed, 29 Jan 2020 22:42:52 +0800 Subject: [PATCH] Update readme. --- README.md | 27 +++++++++++++++++++++++---- 1 file changed, 23 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a4efa02a..6b5f2ae0 100644 --- a/README.md +++ b/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 +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 ` 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