Improve build instructions in README.md #1315
Conversation
kentyman23
changed the title
| @@ -3,26 +3,43 @@ | |||
| [](https://ci.appveyor.com/project/cgutman/moonlight-android/branch/master) | |||
| [](https://hosted.weblate.org/projects/moonlight/moonlight-android/) | |||
|
|
|||
| [Moonlight for Android](https://moonlight-stream.org) is an open source client for NVIDIA GameStream and [Sunshine](https://github.com/LizardByte/Sunshine). | |||
| [Moonlight](https://moonlight-stream.org/) for Android is an open source client for | |||
| [Nvidia GameStream](https://www.nvidia.com/en-us/support/gamestream/) and | |||
There was a problem hiding this comment.
Is there value in linking to a dead service?
There was a problem hiding this comment.
Maybe not, but I figured since people still get support in #geforce-experience in Discord that maybe we weren't ready to stop mentioning it. I defer to the maintainer.
| ## Building | ||
| * Install Android Studio and the Android NDK | ||
| * Run ‘git submodule update --init --recursive’ from within moonlight-android/ | ||
| * In moonlight-android/, create a file called ‘local.properties’. Add an ‘ndk.dir=’ property to the local.properties file and set it equal to your NDK directory. |
There was a problem hiding this comment.
Can I get confirmation from someone with more Android development experience that we can indeed totally remove the need for local.properties given the instructions I laid out. It seemed to work on my machine, but I want to make sure there are no side effects I'm not considering.
There was a problem hiding this comment.
I just got into working on this project, and I was able to build the app without creating the local.properties file.
I am getting some issues when running the app in Android Emulator though (specifically I cannot pair the app to Sunshine)... but I kind of doubt it's because of that file.
Edits:
- The pairing issues seem random, probably it is timeout issues due to Android Emulator being slow, and the debug build adding a little extra slowness.
- The
local.propertiesfile was created automatically for me with the contents below. maybe with these contents it doesn't need the NDK directory specifically?
## This file must *NOT* be checked into Version Control Systems,
# as it contains information specific to your local configuration.
#
# Location of the SDK. This is only used by Gradle.
# For customization when using a Version Control System, please read the
# header note.
#Thu Jul 11 14:58:55 EDT 2024
sdk.dir=C\:\\Users\\ReenigneArcher\\AppData\\Local\\Android\\Sdk| 1. Determine which version to use by finding `ndkVersion` in | ||
| [`app/build.gradle`](app/build.gradle) | ||
| 1. In Android Studio, open _Tools»SDK Manager_ | ||
|  | ||
| 1. Click the _SDK Tools_ tab | ||
| 1. Enable the _Show Package Details_ checkbox in the bottom-right | ||
| 1. Expand the _NDK (Side by side)_ category | ||
| 1. Enable the checkbox for the version determined above | ||
| 1. Click OK |
There was a problem hiding this comment.
For me, it automatically installed the NDK version that was specified in the gradle file, but this is probably still helpful information.
| You can follow development on our [Discord server](https://moonlight-stream.org/discord) and help translate Moonlight into your language on [Weblate](https://hosted.weblate.org/projects/moonlight/moonlight-android/). | ||
| You can follow development on our [Discord server](https://moonlight-stream.org/discord) | ||
| and help translate Moonlight into your language on | ||
| [Weblate](https://hosted.weblate.org/projects/moonlight/moonlight-android/). |
There was a problem hiding this comment.
I have one question about translations (for developers) that could probably be clarified here.
Updated
README.mdwith more explicit instructions on installing the NDK to ensure others don't run into issues I had when first starting. I also was able to remove warnings about deprecated use oflocal.propertiesto point to the NDK. While I was at it, I made various small wording/formatting tweaks to the file.