Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/naoghuman/lib-release

TODO
https://github.com/naoghuman/lib-release

java java-8 javafx javafx-8 javafx-library json library maven netbeans

Last synced: 3 months ago
JSON representation

TODO

Awesome Lists containing this project

README

        

Lib-Release
===

[![Build Status](https://travis-ci.org/Naoghuman/lib-release.svg?branch=master)](https://travis-ci.org/Naoghuman/lib-release)
[![license: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![GitHub release](https://img.shields.io/github/release/Naoghuman/lib-release.svg)](https://GitHub.com/Naoghuman/lib-release/releases/)

Intention
---

TODO

Content
---

* [Examples](#Examples)
- [How to use...](#HoToUs)
* [API](#API)
- [com.github.naoghuman.lib.release](#Rel1)
* [Download](#Download)
* [Requirements](#Requirements)
* [Installation](#Installation)
* [Documentation](#Documentation)
* [Contribution](#Contribution)
* [License](#License)
* [Autor](#Autor)
* [Contact](#Contact)

Examples
---

### How to use...

TODO
```java
```

API
---

### com.github.naoghuman.lib.release

Download
---

Current `version` is `0.2.0-PRERELEASE`. Main points in this release are:
* Create basic api for the library.

Download:
* [Release v0.2.0-PRERELEASE] (12.02.2018 / MM.dd.yyyy)

An overview about all existings releases can be found here:
* [Overview] from all releases in `Lib-Release`.

Requirements
---

* On your system you need [JRE 8] or [JDK 8] installed.
* The library [lib-release-0.2.0-PRERELEASE.jar](#Installation).

In the library are following libraries registered as dependencies:
* The library [lib-logger-0.6.0.jar](#Installation).
* Included in `Lib-Logger` is the library [log4j-api-2.10.0.jar].
* Included is `Lib-Logger` is the library [log4j-core-2.10.0.jar].

Installation
---

##### Install the project in your preferred IDE

* If not installed download the [JRE 8] or the [JDK 8].
- Optional: To work better with [FXML] files in a [JavaFX] application
download the JavaFX [Scene Builder] supported by `Gluon`.
* Choose your preferred IDE (e.g. [NetBeans], [Eclipse] or [IntelliJ IDEA]) for development.
* Download or clone [Lib-Logger].
* Open the projects in your IDE and run them.

Documentation
---

* In the section [Examples](#Examples) there are different `How to use...` sub-sections
which explained the main points from this library.
* In the section [Api](#Api) you can see the main functionalities from this library.
* For additional information see the [JavaDoc] in the library itself.

Contribution
---

* If you find a `Bug` I will be glad if you could report an [Issue].
* If you want to contribute to the project plz fork the project and do a [Pull Request].

License
---

The project `Lib-Release` is licensed under [General Public License 3.0].

Autor
---

The project `Lib-Release` is maintained by me, Peter Rogge. See [Contact](#Contact).

Contact
---

You can reach me under .

[//]: # (Images)

[//]: # (Links)
[Eclipse]:https://www.eclipse.org/
[FXML]:http://docs.oracle.com/javafx/2/fxml_get_started/jfxpub-fxml_get_started.htm
[General Public License 3.0]:http://www.gnu.org/licenses/gpl-3.0.en.html
[IntelliJ IDEA]:http://www.jetbrains.com/idea/
[Issue]:https://github.com/Naoghuman/lib-release/issues
[JavaDoc]:http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html
[JavaFX]:http://docs.oracle.com/javase/8/javase-clienttechnologies.htm
[JDK 8]:http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
[JRE 8]:http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html
[Lib-Logger]:https://github.com/Naoghuman/lib-logger
[log4j-api-2.10.0.jar]:https://logging.apache.org/log4j/2.0/log4j-web/dependencies.html
[log4j-core-2.10.0.jar]:https://logging.apache.org/log4j/2.0/log4j-web/dependencies.html
[NetBeans]:https://netbeans.org/
[Overview]:https://github.com/Naoghuman/lib-release/releases
[Pull Request]:https://help.github.com/articles/using-pull-requests
[Release v0.2.0-PRERELEASE]:https://github.com/Naoghuman/lib-release/releases/tag/v0.2.0-PRERELEASE
[Scene Builder]:https://gluonhq.com/products/scene-builder/