Merge pull request #6 from mauritssilvis/java_darts_cli_release

Streamline the Java darts CLI installation
mauritssilvis · Mar 15, 2023 · 55b0c73 · 55b0c73
2 parents 8207600 + 7ee43f9
commit 55b0c73
Show file tree

Hide file tree

Showing 21 changed files with 178 additions and 516 deletions.
diff --git a/cli/java/.gitignore b/cli/java/.gitignore
@@ -35,14 +35,14 @@
 # When using Gradle or Maven with auto-import, you should exclude module files,
 # since they will be recreated, and may cause churn.  Uncomment if using
 # auto-import.
-# .idea/artifacts
-# .idea/compiler.xml
-# .idea/jarRepositories.xml
-# .idea/modules.xml
-# .idea/*.iml
-# .idea/modules
-# *.iml
-# *.ipr
+.idea/artifacts
+.idea/compiler.xml
+.idea/jarRepositories.xml
+.idea/modules.xml
+.idea/*.iml
+.idea/modules
+*.iml
+*.ipr
 
 # CMake
 cmake-build-*/
@@ -163,6 +163,10 @@ gradle-app.setting
 # JDT-specific (Eclipse Java Development Tools)
 .classpath
 
+# Distribution
+bin/
+lib/
+
 ### Gradle Patch ###
 # Java heap dump
 *.hprof

diff --git a/cli/java/.idea/compiler.xml b/cli/java/.idea/compiler.xml
diff --git a/cli/java/.idea/jarRepositories.xml b/cli/java/.idea/jarRepositories.xml
diff --git a/cli/java/.idea/modules.xml b/cli/java/.idea/modules.xml
diff --git a/cli/java/.idea/modules/java-darts-cli.main.iml b/cli/java/.idea/modules/java-darts-cli.main.iml
diff --git a/cli/java/.idea/modules/nl.mauritssilvis.darts.java.java-darts-cli.main.iml b/cli/java/.idea/modules/nl.mauritssilvis.darts.java.java-darts-cli.main.iml
diff --git a/cli/java/CHANGELOG.md b/cli/java/CHANGELOG.md
@@ -5,6 +5,30 @@ All notable changes to the `java-darts-cli` project (see [darts](https://github.
 The file format is based on [keep a changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [semantic versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.0] - 2023-03-15
+
+### Changed
+
+#### Documentation
+
+- Document changes in the usage of `darts`.
+
+#### Installation
+
+- Change the `darts` installation location.
+
+#### Dependencies
+
+- Update the Gradle version to 8.0.2.
+- Update the Lombok version to 1.18.26.
+- Update the JUnit version to 5.9.2.
+
+### Removed
+
+#### Execution
+
+- Remove scripts to run `darts` from the project folder.
+
 ## [0.1.0] - 2023-03-15
 
 ### Added
@@ -15,9 +39,12 @@ and this project adheres to [semantic versioning](https://semver.org/spec/v2.0.0
 - Document the usage of the `darts` command-line interface.
 - Document potential problems with the installation or usage of `darts`.
 
-#### Execution
+#### Installation
 
 - Add scripts to install `darts` in the project folder (`install`).
+
+#### Execution
+
 - Add scripts to run `darts` from the project folder (`darts`).
 
 #### Command-line interface

diff --git a/cli/java/README.md b/cli/java/README.md
@@ -48,35 +48,43 @@ To install the `darts` toolbox, first follow the following steps:
 
 You can then install the `darts` toolbox as follows:
 
-- Navigate to the folder containing the `darts` installation and execution scripts.
-    - If you downloaded the latest `java-darts-cli` release, navigate to the extracted folder.
-    - If you downloaded the full `darts` code, navigate to the `cli/java` folder that is part of that code.
-- Run the `install` command to install `darts` in the current folder.
+- Navigate to the folder containing the `darts` installation scripts, `install` and `install.bat`.
+    - If you downloaded the latest `java-darts-cli` release, these scripts can be found in the extracted folder.
+    - If you downloaded the full `darts` code, these scripts can be found in the `cli/java` folder of that code.
+- Run the `install` command to install `darts` in the `bin` folder.
+- Navigate to the newly created `bin` folder.
 - Test the execution of the `darts` toolbox by running the `darts` command.
 
 #### 1.2.1 Command execution
 
+##### Unix-like systems
+
 On Unix-like systems, the `install` and `darts` commands can be executed as follows:
 
 - Open a terminal.
-- Navigate to the folder containing the `darts` installation and execution scripts.
+- Navigate to the folder containing the `darts` installation script, `install`.
 - Run the `install` command by executing `./install`.
+- Navigate to the newly created `bin` folder.
 - Run the `darts` command by executing `./darts`.
 
+##### Windows
+
 On Windows, the `install` and `darts` commands can be executed using the command prompt or the PowerShell.
 
 With the command prompt, the execution of commands works as follows:
 
 - Open the command prompt, for example, by pushing the `Windows key`, typing `cmd` and hitting `Enter`.
-- Navigate to the folder containing the `darts` installation and execution scripts.
+- Navigate to the folder containing the `darts` installation script, `install.bat`.
 - Run the `install` command by executing `install`.
+- Navigate to the newly created `bin` folder.
 - Run the `darts` command by executing `darts`.
 
 With the PowerShell, execution works as follows:
 
 - Open the PowerShell, for example, by pushing the `Windows key`, typing `powershell` and hitting `Enter`.
-- Navigate to the folder containing the `darts` installation and execution scripts.
+- Navigate to the folder containing the `darts` installation script, `install.bat`.
 - Run the `install` command by executing `.\install`.
+- Navigate to the newly created `bin` folder.
 - Run the `darts` command by executing `.\darts`.
 
 #### 1.2.2 Troubleshooting
@@ -827,11 +835,15 @@ install: missing file operand
 Try 'install --help' for more information.
 ```
 
+```text
+./install: No such file or directory
+```
+
 To solve these problems, take the following steps:
 
-- Ensure you navigated to the folder containing the `darts` installation and script.
-    - If you downloaded the latest `java-darts-cli` release, navigate to the extracted folder.
-    - If you downloaded the full `darts` code, navigate to the `cli/java` folder that is part of that code.
+- Ensure you navigated to the folder containing the `darts` installation scripts, `install` and `install.bat`.
+    - If you downloaded the latest `java-darts-cli` release, these scripts can be found in the extracted folder.
+    - If you downloaded the full `darts` code, these scripts can be found in the `cli/java` folder of that code.
 - Prefix the `install` command with `./` (Bash) or `.\` (PowerShell) before execution.
 
 #### 3.1.2 Java was not installed or found
@@ -907,12 +919,17 @@ darts : The term 'darts' is not recognized as the name of a cmdlet, function,
 script file, or operable program.
 ```
 
+```text
+./darts: No such file or directory
+```
+
 To solve these problems, take the following steps:
 
 - Install `darts` by following the [installation instructions](#1-installation).
-- Navigate to the folder containing the `darts` execution script.
-    - If you downloaded the latest `java-darts-cli` release, navigate to the extracted folder.
-    - If you downloaded the full `darts` code, navigate to the `cli/java` folder that is part of that code.
+- Ensure you navigated to the folder containing the `darts` installation scripts, `install` and `install.bat`.
+    - If you downloaded the latest `java-darts-cli` release, these scripts can be found in the extracted folder.
+    - If you downloaded the full `darts` code, these scripts can be found in the `cli/java` folder of that code.
+- Navigate to the `bin` folder.
 - Prefix the `darts` command with `./` (Bash) or `.\` (PowerShell) before execution.
 
 #### 3.2.2 Missing required subcommand

diff --git a/cli/java/build.gradle b/cli/java/build.gradle