From 6026430389e30cec38902be1d60c7e4e6fabc887 Mon Sep 17 00:00:00 2001 From: James Seager Date: Tue, 8 Aug 2023 14:52:04 +0100 Subject: [PATCH 1/2] Update command to create robot.bat file * Fix a typo * Note that the command should be run with a specific Powershell version --- docs/index.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 84f79a287..11f5fc80d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -39,7 +39,8 @@ The command-line tool is packaged a Java JAR file and can be run via the `robot` 1. Download the `robot.jar` file from the [latest release](https://github.com/ontodev/robot/releases/latest). 2. Save the [ROBOT batch script](https://github.com/ontodev/robot/raw/master/bin/robot.bat). - Make sure this is saved as `.bat` and not `.bat.txt` - - OR enter `"java %ROBOT_JAVA_ARGS% -jar %~dr0robot.jar %*" | out-file robot.bat -encoding utf8` in the same directory as `robot.jar` to create the batch script. + - OR in [PowerShell](https://learn.microsoft.com/powershell/), run `"java %ROBOT_JAVA_ARGS% -jar %~dp0robot.jar %*" | out-file robot.bat -encoding utf8` in the same directory as `robot.jar` to create the batch script. + - Note that the above command requires PowerShell version 6 or later: previous versions will write a Unicode byte order mark to the file, which breaks the command. 3. Put both files on your [system PATH](https://en.wikipedia.org/wiki/PATH_(variable)) in the same directory. - this could be `C:\Windows\` - OR [update your PATH](https://docs.oracle.com/javase/tutorial/essential/environment/paths.html) to include the new directory. From 5e4b1d9ab765d277ca14cc8009baf081fd2b547c Mon Sep 17 00:00:00 2001 From: James Seager Date: Wed, 9 Aug 2023 10:18:10 +0100 Subject: [PATCH 2/2] Add BOM acronym to Windows installation instructions Co-authored-by: Emily Hartley --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 11f5fc80d..7e77924d3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -40,7 +40,7 @@ The command-line tool is packaged a Java JAR file and can be run via the `robot` 2. Save the [ROBOT batch script](https://github.com/ontodev/robot/raw/master/bin/robot.bat). - Make sure this is saved as `.bat` and not `.bat.txt` - OR in [PowerShell](https://learn.microsoft.com/powershell/), run `"java %ROBOT_JAVA_ARGS% -jar %~dp0robot.jar %*" | out-file robot.bat -encoding utf8` in the same directory as `robot.jar` to create the batch script. - - Note that the above command requires PowerShell version 6 or later: previous versions will write a Unicode byte order mark to the file, which breaks the command. + - Note that the above command requires PowerShell version 6 or later: previous versions will write a Unicode byte order mark (BOM) to the file, which breaks the command. 3. Put both files on your [system PATH](https://en.wikipedia.org/wiki/PATH_(variable)) in the same directory. - this could be `C:\Windows\` - OR [update your PATH](https://docs.oracle.com/javase/tutorial/essential/environment/paths.html) to include the new directory.