Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve build instructions in README.md #1315

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

kentyman23
Copy link

Updated README.md with 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 of local.properties to point to the NDK. While I was at it, I made various small wording/formatting tweaks to the file.

@kentyman23 kentyman23 changed the title Update build instructions in README.md Improve build instructions in README.md Jan 15, 2024
Copy link

@ReenigneArcher ReenigneArcher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: I'm not a maintainer here, but saw your PR link in Moonlight and thought I'd give it a review. cgutman may have a different opinion than me.

@@ -3,26 +3,43 @@
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/232a8tadrrn8jv0k/branch/master?svg=true)](https://ci.appveyor.com/project/cgutman/moonlight-android/branch/master)
[![Translation Status](https://hosted.weblate.org/widgets/moonlight/-/moonlight-android/svg-badge.svg)](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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there value in linking to a dead service?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants