From 547334f26b524915f5da45982b4c2af90bfefe69 Mon Sep 17 00:00:00 2001 From: Jannik Date: Sat, 9 Dec 2017 13:19:50 +0100 Subject: [PATCH] Updated Documantation (markdown) --- Documantation.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/Documantation.md b/Documantation.md index 11e3c49..464c59d 100644 --- a/Documantation.md +++ b/Documantation.md @@ -2,7 +2,10 @@ cemu_UI uses maven to manage all dependencies and to build the Software. In order to build cemu_UI make sure you have [Maven](https://maven.apache.org/) and the latest version of java 8 oracle jdk installed. -At first you need to clone cemu_UI `git clone https://github.com/Seil0/cemu_UI.git`, if you have done that go to the root folder of cemu_UI and build the cemu_UI package with `mvn package`. The final package can be found in /target. +At first you need to clone cemu_UI `git clone https://github.com/Seil0/cemu_UI.git`, if you have done that go to the root folder of cemu_UI and build the cemu_UI package with `mvn package`. The final package can be found in _/target/cemu_UI-0.0.0-SNAPSHOT-shaded.jar_. + +### First startup description +At the first start cemu_UI will download a reference game list. This list contains several thousand Wii U games, from which we get the Nintendo ID, cover download url and other necessary information. If cemu_UI has found a game in your ROM directory it will download the cover found on the games reference list and create a new entry in the local_games database. In this local_games database are all information about total play time, last played, cover- and ROM path stored. When cemu_UI has finished searching for ROMs it will add all games from the local_games database to a array-list to work with. ### Cloud sync If you want to build a version that supports the cloud sync, you need to add a "client_secret.json" in "resources/". For more information have a closer look at [developers.google.com](https://developers.google.com/api-client-library/python/guide/aaa_client_secrets). The default client_secret is not included for security reasons.