Updated Documentation (markdown)

Jannik 2017-07-26 17:53:10 +02:00
parent 5cf75435ab
commit 16ff35db3b

@ -1,4 +1,4 @@
## build ## Build
Project-HomeFlix uses maven to manage all dependencies and to build the Software. In order to build Project-HomeFlix Project-HomeFlix uses maven to manage all dependencies and to build the Software. In order to build Project-HomeFlix
make sure you have [Maven](https://maven.apache.org/) installed. make sure you have [Maven](https://maven.apache.org/) installed.
@ -11,7 +11,7 @@ go to the root folder of Project-HomeFlix and execute the following command
The final package can be found in /target. The final package can be found in /target.
## used libraries and apis ## Used libraries and apis
JFoenix: https://github.com/jfoenixadmin/JFoenix JFoenix: https://github.com/jfoenixadmin/JFoenix
minimal-json: https://github.com/ralfstx/minimal-json minimal-json: https://github.com/ralfstx/minimal-json
sqlite-jdbc: https://github.com/xerial/sqlite-jdbc sqlite-jdbc: https://github.com/xerial/sqlite-jdbc
@ -19,7 +19,7 @@ apache commons io: https://commons.apache.org/proper/commons-io/
omdbapi: http://omdbapi.com/ omdbapi: http://omdbapi.com/
## naming schema ## Naming-schema
Project-HomeFlix versions are named after a special naming schema. Project-HomeFlix versions are named after a special naming schema.
The first part of the code name is plasma/glowing/solidify/fossilized, the second part is a random word. The first part of the code name is plasma/glowing/solidify/fossilized, the second part is a random word.
Plasma will always be the latest major version, glowing, solidify and fossilized are minor versions. Plasma will always be the latest major version, glowing, solidify and fossilized are minor versions.