Skip to content
This repository has been archived by the owner on Mar 29, 2021. It is now read-only.

Commit

Permalink
Polished build file
Browse files Browse the repository at this point in the history
Closes #15

Upgraded JFoenix to 9.0.10

Related to #5

Minor readme enhancements
  • Loading branch information
agcom committed Sep 17, 2020
1 parent f7c3bb1 commit f3b00fa
Show file tree
Hide file tree
Showing 4 changed files with 54 additions and 41 deletions.
58 changes: 30 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)

Expand All @@ -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
Expand Down Expand Up @@ -96,15 +98,15 @@ 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
> Being eager isn't always the best option.
>
> 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!
Expand All @@ -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).
26 changes: 16 additions & 10 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -1,29 +1,35 @@
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()
}

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']
}

Expand Down
8 changes: 7 additions & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
kotlin.code.style=official
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
3 changes: 1 addition & 2 deletions settings.gradle
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
rootProject.name = 'quad-tree'

rootProject.name = 'quad-tree'

0 comments on commit f3b00fa

Please sign in to comment.