diff --git a/README.md b/README.md index 82d6659..2243e84 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Have a look, ## Ingredients -Built on top of [Java](https://en.wikipedia.org/wiki/Java_(programming_language)) language with help of the following awesome tools, +Built on top of [Java virtual machine](https://en.wikipedia.org/wiki/Java_virtual_machine) with help of the following awesome tools, - [JavaFX](https://openjfx.io/) @@ -38,35 +38,37 @@ To get a local copy **up and running** follow these simple steps, 1. Make sure **Java 11** or higher is installed. + > Word *Java* is used as a substitution for *JVM*; Java virtual machine. + 2. Clone the repository. - > You can do this either by using the `git` command, - > - > ```sh - > git clone https://github.com/agcom/quad-tree.git - > ``` - > - > or downloading and extracting the [project `zip` artifact](https://github.com/agcom/quad-tree/archive/master.zip). + > You can do this either by using the `git` command, + > + > ```sh + > git clone https://github.com/agcom/quad-tree.git + > ``` + > + > or downloading and extracting the [project's `zip` artifact](https://github.com/agcom/quad-tree/archive/master.zip). 3. Run the application. - > You need to invoke the gradle `run` task to get the application running. - > - > You can use the pre-made **gradle scripts** even if you don't have the required gradle bundle installed. - > - > - On Linux, - > - > ```sh - > ./gradlew run - > ``` - > - > - On Windows, - > - > ```powershell - > ./gradlew.bat run - > ``` - > - > For more information on running batch files on Windows visit this [tutorial](https://www.wikihow.com/Run-a-Batch-File-from-the-Command-Line-on-Windows). + > You need to invoke the gradle `run` task to get the application running. + > + > You can use the pre-made **gradle scripts** even if you don't have the required gradle bundle installed. + > + > - On Linux, + > + > ```sh + > ./gradlew run + > ``` + > + > - On Windows, + > + > ```powershell + > ./gradlew.bat run + > ``` + > + > For more information on running batch files on Windows visit this [tutorial](https://www.wikihow.com/Run-a-Batch-File-from-the-Command-Line-on-Windows). ## Usage @@ -96,7 +98,7 @@ Let's review the application's interesting features, > This may seem strange, but trust me, it's a cool feature! > - > Check the *eraser* box and click/drag the cursor on top of some points. This is where the magic happens! Division redo! + > Check the *eraser* box and click/drag the cursor on top of some points. This is where the magic happens! Division undo! - Adjust the input processing delays @@ -104,7 +106,7 @@ Let's review the application's interesting features, > > Delays are necessary to guarantee a lag free experience! > - > If you're feeling **lags**, try increasing the delays, most importantly the *draw delay*. + > If you're feeling **lags**, try increasing the delays, especially the *draw delay*. - Some cool statistics about your query efficiency! @@ -124,7 +126,7 @@ If you've gone far, share your code with us. **Pull requests** are appreciated. ## Contact us -Got questions? Two ways just for you. +Got questions? Two ways, just for you. - Create an issue with the ![question-lable](https://img.shields.io/github/labels/agcom/quad-tree/question?style=flat-square) label. - Directly contact the [project owner](https://github.com/agcom). \ No newline at end of file diff --git a/build.gradle b/build.gradle index 05f5f94..4e39ad4 100755 --- a/build.gradle +++ b/build.gradle @@ -1,15 +1,21 @@ plugins { id 'application' id 'java' - id 'org.jetbrains.kotlin.jvm' version '1.3.61' - id 'org.openjfx.javafxplugin' version '0.0.8' + id 'org.jetbrains.kotlin.jvm' version "$kotlin_version" + id 'org.openjfx.javafxplugin' version "$javafx_plugin_version" } -group 'ir.agcom' -version '0.1' +group = 'ir.agcom' +version = '1.0.0' -mainClassName = 'Launcher' -sourceCompatibility = 11 +application { + mainClass = 'Launcher' +} + +java { + sourceCompatibility = JavaVersion.VERSION_11 + targetCompatibility = JavaVersion.VERSION_11 +} repositories { mavenCentral() @@ -17,13 +23,13 @@ repositories { dependencies { implementation 'org.jetbrains.kotlin:kotlin-stdlib-jdk8' - implementation 'io.reactivex.rxjava2:rxjavafx:2.2.2' - implementation 'io.reactivex.rxjava2:rxjava:2.2.17' - implementation 'com.jfoenix:jfoenix:9.0.8' + implementation "io.reactivex.rxjava2:rxjavafx:$rxjavafx_version" + implementation "io.reactivex.rxjava2:rxjava:$rxjava_version" + implementation "com.jfoenix:jfoenix:$jfoenix_version" } javafx { - version = '11' + version = "$javafx_version" modules = ['javafx.controls', 'javafx.fxml', 'javafx.base', 'javafx.graphics', 'javafx.swing'] } diff --git a/gradle.properties b/gradle.properties index 29e08e8..865a7f7 100755 --- a/gradle.properties +++ b/gradle.properties @@ -1 +1,7 @@ -kotlin.code.style=official \ No newline at end of file +kotlin.code.style = official +kotlin_version = 1.3.61 +javafx_plugin_version = 0.0.8 +rxjavafx_version = 2.2.2 +rxjava_version = 2.2.17 +jfoenix_version = 9.0.10 +javafx_version = 11 \ No newline at end of file diff --git a/settings.gradle b/settings.gradle index 50a48ee..be9c3be 100755 --- a/settings.gradle +++ b/settings.gradle @@ -1,2 +1 @@ -rootProject.name = 'quad-tree' - +rootProject.name = 'quad-tree' \ No newline at end of file