Updated Documentation (markdown)

Jannik 2017-07-26 17:37:53 +02:00
parent ca9ecf9482
commit 0b5eeadaf6
1 changed files with 14 additions and 5 deletions

@ -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
make sure you have [Maven](https://maven.apache.org/) installed.
@ -12,7 +12,6 @@ The final package can be found in /target.
### used libraries and apis
JFoenix: https://github.com/jfoenixadmin/JFoenix
minimal-json: https://github.com/ralfstx/minimal-json
sqlite-jdbc: https://github.com/xerial/sqlite-jdbc
@ -21,6 +20,16 @@ apache commons io: https://commons.apache.org/proper/commons-io/
omdbapi: http://omdbapi.com/
### naming schema
plasma + name -> glowing + name -> solidify + name -> fossilized + name
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.
Plasma will always be the latest major version, glowing, solidify and fossilized are minor versions.
For example the "cow" series:
* plasma cow
* glowing cow
* solidify cow
* fossilized cow
A new name is always used with a new version, but a new version doesn't always get a new code name.
Code Names:
* bucket (0.3.7 - 0.4.0)
* cow (0.5.0 - current)
* vampire (future)