Skip to content

Commit

Permalink
Updating the README
Browse files Browse the repository at this point in the history
  • Loading branch information
SylvainBertrand committed Jul 11, 2023
1 parent 222deb5 commit cf40299
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 229 deletions.
234 changes: 5 additions & 229 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,242 +1,18 @@
[![HitCount](http://hits.dwyl.io/jfoenixadmin/JFoenix.svg)](http://hits.dwyl.io/jfoenixadmin/JFoenix)
[![][CircleCI img]][CircleCI]
[![][mavenbadge img]][mavenbadge]
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=jfoenixadmin_JFoenix&metric=alert_status)](https://sonarcloud.io/dashboard?id=jfoenixadmin_JFoenix)
[![][gitter img]][gitter]
[![Backers on Open Collective](https://opencollective.com/JFoenix/backers/badge.svg)](#backers)
[![GitHub forks](https://img.shields.io/github/forks/jfoenixadmin/JFoenix.svg)](https://github.com/jfoenixadmin/JFoenix/network)
[![GitHub issues](https://img.shields.io/github/issues/jfoenixadmin/JFoenix.svg)](https://github.com/jfoenixadmin/JFoenix/issues)
[![GitHub license](https://img.shields.io/github/license/jfoenixadmin/JFoenix.svg)](https://github.com/jfoenixadmin/JFoenix/blob/master/LICENSE)
---

<h1 align="center">
<img src="http://www.jfoenix.com/img/logo-JFX.png">
<img src="https://github.com/ihmcrobotics/JFoenix-Group/blob/master/logo-JFX.png">
</h1>
<p align="center">
<sup>
<b>JFoenix is an open source Java library, that implements Google Material Design using Java components</b>
</sup>
</p>

* [JFoenix Site](http://www.jfoenix.com)
* JFoenix for Java 9 - [download jar](https://search.maven.org/remotecontent?filepath=com/jfoenix/jfoenix/9.0.8/jfoenix-9.0.8.jar) (9.x.x)
* JFoenix for Java 8 - [download jar](https://search.maven.org/remotecontent?filepath=com/jfoenix/jfoenix/8.0.8/jfoenix-8.0.8.jar) (8.x.x)
* JFoenix for Android - [download jar](https://search.maven.org/remotecontent?filepath=com/jfoenix/jfoenix/8.0.8/jfoenix-8.0.8-retrolambda.jar)
* Released builds are available from [Maven Central](http://search.maven.org/#search%7Cga%7C1%7CJFoenix)

# Using JFoenix already?
Feel free to create a pull request for adding a link to your project in JFoenix github.
* One more thing, all contributions are appreciated. Don't hesitate to add your own contributions to JFoenix :)

If you like JFoenix :) and want to support this project, you can become a backer on <a href="https://www.patreon.com/shadishaheen">Patreon</a> or <a href="https://opencollective.com/jfoenix">Open Collective</a>.

# Projects using JFoenix
* <a href="http://bcozy.org">BCozy</a>
* <a href="https://github.com/ThijsZijdel/Corendon-LostLuggage">Corendon LostLuggage</a>
* <a href="https://github.com/afsalashyana/Library-Assistant">Library Assistant</a>
* <a href="https://github.com/badarshahzad/Jfx-Browser">JFX-Browser</a>
* <a href="https://github.com/huanghongxun/HMCL">HMCL</a> - Hello Minecraft! Launcher
* By <a href="https://github.com/anongrp">Anongrp</a> in several projects:
<a href="https://github.com/anongrp/Phony">Phony</a>,
<a href="https://github.com/anongrp/ThunderGet">ThunderGet</a>,
<a href="https://github.com/anongrp/Portume">Portume</a>
* By <a href="https://github.com/goxr3plus">GOXR3PLUS</a> in:
<a href="https://github.com/goxr3plus/XR3Player">XR3Player</a>,
<a href="https://github.com/goxr3plus/JavaFX-Web-Browser">JAVAFX WEB Browser</a>
* <a href="https://github.com/bkenn/KFoenix">KFoenix</a>
* <a href="https://github.com/SeynalKim/JavaFXCalendar">JavaFXCalendar</a>
* <a href="https://bitbucket.org/NiNi94/oop16-jlearn/src/master/">JLearn</a> A Juicy Learning app
* <a href="https://github.com/rohan23chhabra/p2p">P2P</a> A peer to peer software
* <a href="https://github.com/DropSnorz/OwlPlug">OwlPlug</a> An Audio plugin manager
* <a href="https://github.com/RubbaBoy/MSPaintIDE">MS Paint IDE</a> Programming in MS Paint
* <a href="https://github.com/fl0wo/TradingFX">TradingFX</a> BitCoin value monitor in real time
* <a href="https://github.com/silentsoft/actlist">Actlist</a> An utility platform to execute your desire things
* <a href="https://github.com/Giulianini/Jestures">Jestures</a> A simple framework for gesture recognition in Java
* <a href="https://github.com/Shehanka/RentLio">RentLio</a> Vehicle Reservation System with RMI Technology
* <a href="https://github.com/ianspryn/Magis">Magis</a> A Computer Aided Instruction Program
* Other small projects <a href="https://github.com/mayuso/JMarkPad">JMarkPad</a>,
<a href="https://github.com/naeemkhan12/CurrencyConverter.git">Currency Converter</a>,
<a href="https://github.com/Anikeshpatel/ColorCode-Pro">ColorCode Pro</a>
* <a href="https://github.com/ykrasik/gamedex">GameDex</a> A digital game collection management application
* <a href="https://github.com/AmrDeveloper/Sparkler">Sparkler</a> A Cross platform API request builder
* <a href="https://github.com/GikuMironica/ExploreHub">ExploreHub</a> An event booking application
* <a href="https://github.com/dubbadhar/gramophy">Gramophy</a> Ad-free, Opensource, YouTube Music Player/Downloader
* [JabRef](https://www.jabref.org/) An opensource (scientific) Reference Manager, mostly used in the LaTeX world
# Fork of dead library JFoenix
This is a fork of the now dead repo JFoenix that is meant to extend a little compatibility to newer versions of Java and JavaFX.
The module declaration has been removed as it was actually working, no guarantee that it'll be added back as it may require much work. This project is focused towards the needs of [SCS2 Project](https://github.com/ihmcrobotics/simulation-construction-set-2).

# Build
To build JFoenix, execute the following command:

gradlew build

To run the main demo, execute the following command:

gradlew run

**NOTE** : You need to set JAVA_HOME environment variable to point to Java 1.8 directory.

**NOTE** : JFoenix requires **Java 1.8u60** and above.
The build has been changed to using the0[ IHMC Gradle Build system](https://github.com/ihmcrobotics/ihmc-build).

# Demo
For detailed steps on getting the demo running, see [the wiki].

# How can I use JFoenix?
You can download the source code of the library and build it as mentioned previously. Building JFoenix will generate jfoenix-0.0.0-SNAPSHOT.jar under the jfoenix/build/libs folder. To use JFoenix, import jfoenix-0.0.0-SNAPSHOT.jar into your project and start using the new material design Java components :).

## Gradle
### How to Include In Gradle Project
```groovy
repositories {
mavenCentral()
}
```
Reference the repository from this location using:
* Java 9+
```groovy
dependencies {
compile 'com.jfoenix:jfoenix:9.0.8'
}
```
* Java 8
```groovy
dependencies {
compile 'com.jfoenix:jfoenix:8.0.8'
}
```
## Maven
### How to Include In Maven Project
* Java 9+
```xml
<dependency>
<groupId>com.jfoenix</groupId>
<artifactId>jfoenix</artifactId>
<version>9.0.8</version>
</dependency>
```
* Java 8
```xml
<dependency>
<groupId>com.jfoenix</groupId>
<artifactId>jfoenix</artifactId>
<version>8.0.8</version>
</dependency>
```
# Components
<details><summary><i>JFXButton </i><a href="https://github.com/jfoenixadmin/JFoenix/wiki/Button"><b>Usage</b></a></summary><p>
![Button Demo](http://jfoenix.com/gif/button.gif "Button Demo")
</p></details>
<details><summary><i>JFXCheckBox </i><a href="https://github.com/jfoenixadmin/JFoenix/wiki/Checkbox"><b>Usage</b></a></summary><p>
![Check Box Demo](http://jfoenix.com/gif/checkbox.gif "Check Box Demo")
</p></details>
<details><summary><i>JFXToggleButton </i><a href="https://github.com/jfoenixadmin/JFoenix/wiki/Toggle-Button"><b>Usage</b></a></summary><p>
![Toggle Button Demo](http://jfoenix.com/gif/toggle-button.gif "Toggle Button Demo")
</p></details>
<details><summary><i>JFXDialog</i></summary><p>
![Dialog Demo](http://jfoenix.com/gif/dialog.gif "Dialog Demo")
</p></details>
<details><summary><i>JFXListView</i></summary><p>
![List View Demo](http://jfoenix.com/gif/listview.gif "List View Demo")
</p></details>
<details><summary><i>JFXHighlighter</i></summary><p>
![Highlighter](http://jfoenix.com/gif/highlighter.gif "Highlighter")
</p></details>
<details><summary><i>JFXChipView</i></summary><p>
![Chip View](http://jfoenix.com/gif/chipview.gif "Chip View")
</p></details>
<details><summary><i>JFXNodesList</i></summary><p>
![Nodes List Demo](http://jfoenix.com/gif/nodes-list.gif "Nodes List Demo")
</p></details>
<details><summary><i>JFXMasonryPane</i></summary><p>
![Masonry Demo](http://jfoenix.com/gif/masonry.gif "Masonry Demo")
</p></details>
<details><summary><i>JFXSlider </i> <a href="https://github.com/jfoenixadmin/JFoenix/wiki/Slider"><b>Usage</b></a></summary><p>
![Slider Demo](http://jfoenix.com/gif/slider.gif "Slider Demo")
</p></details>
<details><summary><i>JFXSpinner</i></summary><p>
![Spinner Demo](http://jfoenix.com/gif/spinner.gif "Spinner Demo")
</p></details>
<details><summary><i>JFXSnackbar</i></summary><p>
![Icons-Snackbar Demo](http://jfoenix.com/gif/icons-snackbar.gif "Icons-Snackbar Demo")
</p></details>
<details><summary><i>JFXColorPicker</i></summary><p>
![Color Picker Demo](http://jfoenix.com/gif/colorpicker-beta.gif "Color Picker Demo")
</p></details>
<details><summary><i>JFXDatePicker</i></summary><p>
![Date Picker Demo](http://jfoenix.com/gif/datepicker.gif "Date Picker Demo")
</p></details>
<details><summary><i>JFXTimePicker</i></summary><p>
![Time Picker Demo](http://jfoenix.com/gif/timepicker.gif "Time Picker Demo")
</p></details>
<details><summary><i>JFXTreeTableView</i></summary><p>
![Tree Table View](http://jfoenix.com/gif/treetableview.gif "Tree Table View")
</p></details>
<details><summary><i>Grouping</i></summary><p>
![Grouping Demo](http://jfoenix.com/gif/grouping.gif "Grouping Demo")
</p></details>
[mavenbadge]:https://search.maven.org/search?q=g:com.jfoenix%20AND%20a:jfoenix&core=gav
[mavenbadge img]:https://maven-badges.herokuapp.com/maven-central/com.jfoenix/jfoenix/badge.svg
[CircleCI]:https://circleci.com/gh/jfoenixadmin/JFoenix/tree/master
[CircleCI img]:https://circleci.com/gh/jfoenixadmin/JFoenix/tree/master.svg?style=shield
[gitter]:https://gitter.im/JFoenix/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
[gitter img]:https://badges.gitter.im/JFoenix/Lobby.svg
[the wiki]: https://github.com/jfoenixadmin/JFoenix/wiki#trying-the-demo
## Contributors
This project exists thanks to all the people who contribute.
<a href="https://github.com/jfoenixadmin/JFoenix/contributors"><img src="https://opencollective.com/JFoenix/contributors.svg?width=890&button=false" /></a>
## Special Thanks
Special thanks to <a href="https://www.jetbrains.com">JetBrains</a> and <a href="https://www.ej-technologies.com/products/jprofiler/overview.html">JProfiler</a> for their support to this project.
Binary file added logo-JFX.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit cf40299

Please sign in to comment.