From 7c2324eda01a3974ff89aa1e4ee7a594d278662a Mon Sep 17 00:00:00 2001 From: SSimco <37044560+SSimco@users.noreply.github.com> Date: Sat, 9 May 2026 17:48:53 +0300 Subject: [PATCH] docs: add Android build steps & Kotlin coding style --- BUILD.md | 11 +++++++++++ CODING_STYLE.md | 4 +++- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/BUILD.md b/BUILD.md index 6e1a2be9..24148c09 100644 --- a/BUILD.md +++ b/BUILD.md @@ -20,6 +20,7 @@ - [Installing Tool Dependencies](#installing-tool-dependencies) - [Installing Library Dependencies](#installing-library-dependencies) - [Build Cemu using CMake](#build-cemu-using-cmake) +- [Android](#android) - [FreeBSD](#freebsd) - [Installing Dependencies](#installing-dependencies) - [Build Cemu on BSD with CMake](#build-cemu-on-bsd-with-cmake) @@ -198,6 +199,16 @@ Alternatively, you can use the non-privateapi version of MoltenVK, but you may e - **On an Apple Silicon Mac:** `-DCMAKE_MAKE_PROGRAM=/opt/homebrew/bin/ninja` - **On an Intel Mac:** `-DCMAKE_MAKE_PROGRAM=/usr/local/bin/ninja` +## Android +Prerequisites: +- git +- [Android studio](https://developer.android.com/studio) + +Instructions: +1. Run `git clone --recursive https://github.com/cemu-project/Cemu` +2. Open the project located in `src/android` in Android Studio +3. Click Build > Make Project + ## FreeBSD The following instructions to build Cemu on FreeBSD are experimental. Some features available on other platforms are not available on FreeBSD (discord rich presence, bluetooth/support for actual Wii U controllers, auto-updates, etc.) diff --git a/CODING_STYLE.md b/CODING_STYLE.md index d9d44c54..58fbb9b1 100644 --- a/CODING_STYLE.md +++ b/CODING_STYLE.md @@ -1,7 +1,9 @@ # Coding style guidelines for Cemu -This document describes the latest version of our coding-style guidelines. Since we did not use this style from the beginning, older code may not adhere to these guidelines. Nevertheless, use these rules even if the surrounding code does not match. +This document describes the latest version of our coding-style guidelines. Since we did not use this style from the beginning, older code may not adhere to these guidelines. Nevertheless, use these rules even if the surrounding code does not match. + +These coding-style guidelines apply only to the C/C++ codebase. For Kotlin, we follow the official Kotlin Coding Conventions as outlined in the [Kotlin documentation](https://kotlinlang.org/docs/coding-conventions.html). Cemu comes with a `.clang-format` file which is supported by most IDEs for formatting. Avoid auto-reformatting whole files, PRs with a lot of formatting changes are difficult to review.