diff --git a/README.md b/README.md index b4d8fac..52e9962 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,30 @@ -# Generate Table in JavaFx -Simple tool using to generate code of JFXTreeTableView, (this table included in JFoenix library). +# Generate Table in JavaFX +FXTableGen is a simple tool using to generate code of JFXTreeTableView (this kind of table included in JFoenix library). -[![License MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/HouariZegai/GenerateTableFx/blob/master/LICENSE) +[![License MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) -## Screenshot -gen table image +### Screenshots +![app screenshot](screenshots/gen-table-fx.PNG) -## Features -* Simple to use. -* Fast code generation. -* Pure java (don't need any configuration to use this tool). +### Features +* Easy to use +* Fast code generation +* Pure java (don't need any configuration to use this tool) -## Requirements -* Java version 8 -* JFoenix (Material design library) +### Requirements +* Java version 8 (JDK 8) +* Maven -## Installation -* Clone the project ` git clone https://github.com/HouariZegai/GenerateTableFx.git` +### Technologies & Libraries used +* JavaFX +* JFoenix -## Contributing +### Installation +1. Download the repository files (project) from the download section or clone this project by typing in the bash the following command: + + git clone https://github.com/HouariZegai/FXTableGen.git +2. Open it in Intellij IDEA and download the libraries used (mentioned above) and add it in the project. +3. Run the application :D + +### Contributing 💡 If you want to contribute to this project and make it better with new ideas, your pull request is very welcomed. If you find any issue you can put it in the repository issue section, thank you.