mirror of
https://github.com/cemu-project/Cemu.git
synced 2026-07-09 17:14:47 -06:00
docs: add Android build steps & Kotlin coding style
This commit is contained in:
parent
d79373eec2
commit
7c2324eda0
11
BUILD.md
11
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.)
|
||||
|
||||
@ -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.
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user