Seil0/cemu_UI
1
0
Fork 0
Code Issues 2 Pull Requests Releases 4 Wiki Activity

Updated Documantation (markdown)

Jannik 2017-11-14 11:57:23 +01:00
parent 3bd67a55a7
commit bb89eebc6a
1 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
Documantation.md

@ -1,12 +1,11 @@
## building cemu_UI
## Build cemu_UI
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.
1) read the license
2) download/clone the git repository
3) make sure you have the latest version of java 8 oracle jdk installed
4) if want to use the cloud integration a client-secret is needed in "resources/client_secret.json" see [google doc](https://developers.google.com/api-client-library/python/guide/aaa_client_secrets). The default is not included for security reasons.
5) place the unzip repository into your workspace and start eclipse, project should now be there or import the project to your workspace
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.
this will be reworked soon!
### 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 hav 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.
## Used libraries and apis
* JFoenix: https://github.com/jfoenixadmin/JFoenix
@ -16,14 +15,14 @@ this will be reworked soon!
* Apache commons logging: https://commons.apache.org/proper/commons-logging/
* Apache commons codec: https://commons.apache.org/proper/commons-codec/
* Apache Log4j 2: https://logging.apache.org/log4j/2.x/
* Google Drive Api libraries
* Google Drive Api libraries: https://developers.google.com/drive/
* zip4j
## coding style
unfortunately there is no coding style yet
https://github.com/Seil0/cemu_UI/blob/master/CONTRIBUTING.md#java-sytleguide
## Version schema and naming
cemu_UI is always named after a song from a random Nintendo Game.
* current: "Throwback Galaxy"
* v0.2.x: "Puzzle Plank Galaxy"
* v0.1.x: "Throwback Galaxy"
* current(v0.2.x): "Puzzle Plank Galaxy"
* v0.3.x: ""