From 00eb8f95e4a70f61401f77ca9eaa7142447527df Mon Sep 17 00:00:00 2001 From: SSimco <37044560+SSimco@users.noreply.github.com> Date: Mon, 10 Mar 2025 19:14:20 +0200 Subject: [PATCH] Update doc --- BUILD.md | 11 +++++++++++ CODING_STYLE.md | 1 + README.md | 2 +- 3 files changed, 13 insertions(+), 1 deletion(-) diff --git a/BUILD.md b/BUILD.md index 44d69c6c..c6b2d052 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) - [Updating Cemu and source code](#updating-cemu-and-source-code) ## Windows @@ -182,6 +183,16 @@ Then install the dependencies: #### Troubleshooting steps - If step 3 gives you an error about not being able to find ninja, try appending `-DCMAKE_MAKE_PROGRAM=/usr/local/bin/ninja` to the command and running it again. +## 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 + ## Updating Cemu and source code 1. To update your Cemu local repository, use the command `git pull --recurse-submodules` (run this command on the Cemu root). - This should update your local copy of Cemu and all of its dependencies. diff --git a/CODING_STYLE.md b/CODING_STYLE.md index 39e1d342..2aff0982 100644 --- a/CODING_STYLE.md +++ b/CODING_STYLE.md @@ -2,6 +2,7 @@ # 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. +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. diff --git a/README.md b/README.md index dfd35791..c9fe167b 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ Cemu is currently only available for 64-bit Windows, Linux & macOS devices. ## Download -You can download the latest Cemu releases for Windows, Linux and Mac from the [GitHub Releases](https://github.com/cemu-project/Cemu/releases/). For Linux you can also find Cemu on [flathub](https://flathub.org/apps/info.cemu.Cemu). +You can download the latest Cemu releases for Windows, Linux, Mac, and Android from the [GitHub Releases](https://github.com/cemu-project/Cemu/releases/). For Linux you can also find Cemu on [flathub](https://flathub.org/apps/info.cemu.Cemu). On Windows Cemu is currently only available in a portable format so no installation is required besides extracting it in a safe place.