Skip to content

Commit fa498e2

Browse files
committed
docs: add Android build steps & Kotlin coding style
1 parent b2bee4b commit fa498e2

2 files changed

Lines changed: 14 additions & 1 deletion

File tree

BUILD.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
- [Installing Tool Dependencies](#installing-tool-dependencies)
2121
- [Installing Library Dependencies](#installing-library-dependencies)
2222
- [Build Cemu using CMake](#build-cemu-using-cmake)
23+
- [Android](#android)
2324
- [FreeBSD](#freebsd)
2425
- [Installing Dependencies](#installing-dependencies)
2526
- [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
198199
- **On an Apple Silicon Mac:** `-DCMAKE_MAKE_PROGRAM=/opt/homebrew/bin/ninja`
199200
- **On an Intel Mac:** `-DCMAKE_MAKE_PROGRAM=/usr/local/bin/ninja`
200201

202+
## Android
203+
Prerequisites:
204+
- git
205+
- [Android studio](https://developer.android.com/studio)
206+
207+
Instructions:
208+
1. Run `git clone --recursive https://github.com/cemu-project/Cemu`
209+
2. Open the project located in `src/android` in Android Studio
210+
3. Click Build > Make Project
211+
201212
## FreeBSD
202213

203214
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.)

CODING_STYLE.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11

22
# Coding style guidelines for Cemu
33

4-
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.
4+
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.
5+
6+
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).
57

68
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.
79

0 commit comments

Comments
 (0)