Skip to content

Expand the set up section of the README #220

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

Merged
merged 6 commits into from
May 30, 2025

Conversation

footballhead
Copy link
Collaborator

First, CMake and Ninja are required, so tell people to install them.

Second, the way that Gradle works requires a few specific call-outs in our setup instructions:

  1. Echo Java 17 requiement. Gradle is used to build the Android part of GFXR. Each version of Gradle has a maximum supported version of Java; see: https://docs.gradle.org/current/userguide/compatibility.html. GFXR uses Gradle 8.1 which has a max supported version of Java 19 (to invoke Gradle itself). While technically 18 and 19 are supported, Debian does not provide those versions through the package manager.
  2. While Gradle will automatically download the SDK and NDK that it needs for a project, it will only do so if you have accepted the licenses. The easiest way to do this is to install Android Studio get an SDK through the setup process. After accepting the licenses, Gradle will be happy to take care of the rest. Also, Android Studio is essentially the only way to attach a debugger to Android apps.

First, CMake and Ninja are required, so tell people to install them.

Second, the way that Gradle works requires a few specific call-outs
in our setup instructions:

1. Echo Java 17 requiement. Gradle is used to build the Android part
   of GFXR. Each version of Gradle has a maximum supported version of
   Java; see: https://docs.gradle.org/current/userguide/compatibility.html.
   GFXR uses Gradle 8.1 which has a max supported version of Java 19 (to
   invoke Gradle itself). While technically 18 and 19 are supported,
   Debian does not provide those versions through the package manager.
2. While Gradle will automatically download the SDK and NDK that it
   needs for a project, it will only do so if you have accepted the
   licenses. The easiest way to do this is to install Android Studio get
   an SDK through the setup process. After accepting the licenses,
   Gradle will be happy to take care of the rest. Also, Android Studio
   is essentially the only way to attach a debugger to Android apps.
@footballhead footballhead requested review from elviscapiaq and removed request for angela28chen May 26, 2025 15:43
elviscapiaq
elviscapiaq previously approved these changes May 26, 2025
Copy link
Collaborator

@elviscapiaq elviscapiaq left a comment

Choose a reason for hiding this comment

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

Thanks for adding it.

RenfengLiu
RenfengLiu previously approved these changes May 28, 2025
@footballhead footballhead merged commit 151dfff into google:main May 30, 2025
7 checks passed
@footballhead footballhead deleted the readme_java branch May 30, 2025 19:30
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.

3 participants