Skip to content

Update android example setup README.md #11

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.

Sign up for GitHub

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 2 commits into from
Aug 28, 2024
Merged

Update android example setup README.md #11

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
87022ca
Update android example setup README.md
murki Aug 28, 2024
c926b11
Update examples/README.md
murki Aug 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 23 additions & 13 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,18 @@ brew install --cask zulu-jdk8 zulu-jdk11 zulu-jdk-17

To install without Homebrew you can follow these instructions: [https://docs.azul.com/core/zulu-openjdk/install/macos](https://docs.azul.com/core/zulu-openjdk/install/macos)

### 2. Import hello-world project into Android Studio
### 2. Install Rust

Install it locally using [their installation script](https://www.rust-lang.org/tools/install)

`curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh`

make sure to add it to your path, e.g.

`echo 'export PATH="~/.cargo/bin:$PATH"' >> ~/.zshrc`

### 3. Import demo app project into Android Studio

To use Android Studio:
- Install [Android Studio](https://developer.android.com/studio/archive/). The latest verified-to-work version is Android Studio Jellyfish | 2023.3.1 Patch 1. When asked to choose between default or custom installation selecting standard works fine.

#### Opening Loop SDK project in Android Studio with Gradle
Expand All @@ -41,7 +50,7 @@ Setup the environment, open Android Studio.

![](../docs/images/android_local_gradle_error.png)

- Go to Tools > SDK Manager > Android SDK > SDK Tools. Make sure that "Show Package Details" is checked and install the NDK version that is required by the project (currently `25.2.9519653`).
- Go to Tools > SDK Manager > Android SDK > SDK Tools. Make sure that "Show Package Details" is checked and install the NDK version that is required by the project (currently `27.0.12077973`).

![](../docs/images/android_local_gradle_ndk.png)

Expand All @@ -58,8 +67,6 @@ Setup the environment, open Android Studio.
rustup target add x86_64-linux-android
```



#### Opening Loop SDK project in Android Studio with Bazel

- Install [bazel plugin](https://plugins.jetbrains.com/plugin/9185-bazel-for-android-studio)
Expand All @@ -86,18 +93,21 @@ Set up the environment, open Android Studio.

![](../docs/images/android_local_dev_sync.png)

#### Run tests
To run only the JVM tests from command line with bazel use:
`./bazelw test //platform/jvm/...`

- If you get an error trying to run tests from Android Studio, you need to install LLVM
`brew install llvm`

and add it to your path, e.g.

`echo 'export PATH="/opt/homebrew/opt/llvm/bin:$PATH"' >> ~/.zshrc`

#### Entering debugging session

With the project ready, you can now start debugging with Android Studio.

1. From Android Studio select one of the available configurations. Note: If you do not see any configuration available either restart Android Studio or click "Add configuration" and select a desired configuration.
1. Hit the debug icon.
1. Optionally you could create symbolic breakpoints before running by going to the Debugger tab.

### 3. Install LLVM so you can run unit tests in Android Studio

`brew install llvm`

and add it to your path, e.g.

`echo 'export PATH="/opt/homebrew/opt/llvm/bin:$PATH"' >> ~/.zshrc`