Refine README.md for running JabKit (#13484)

* Refine README.md for running JabKit

* Update README.md

Co-authored-by: Subhramit Basu <subhramit.bb@live.in>

* Use fenced code blocks

* Move JBang part from main README.md to .jbang/README.md

* Fix casing of JBang

---------

Co-authored-by: Subhramit Basu <subhramit.bb@live.in>

Author: koppor

.jbang/README.md

@@ -1,26 +1,53 @@
 # JBang scripts for JabRef
 
-This directory contains [JBang](https://www.jbang.dev/) scripts for JabRef.
+This directory contains JBang scripts for JabRef.
+[JBang](https://www.jbang.dev/) allows for running Java applications without having a JDK installed (before).
 
 Three use cases:
 
 - Try out any pull request with minimal installation. See [our blog entry](https://blog.jabref.org/2025/05/31/run-pr/) for details.
-- Run `JabKit` - JabRef's CLI tool.
-- Run `JabSrv` - JabRef's HTTP server.
+- Run JabKit - JabRef's CLI tool.
+- Run JabSrv - JabRef's HTTP server.
 
-## Running `JabKit`
+## Running JabKit without installation
 
-If you have JBang installed, just run `jbang jabkit@jabref --help`
+By using [gg.cmd](https://github.com/eirikb/gg#ggcmd) you can "just run" JabKit with minimal setup:
 
-If not, download [`gg.cmd`](https://github.com/eirikb/gg/tree/main?tab=readme-ov-file#ggcmd), place it in the current directory (or on your `PATH`) and execute:
+1. Download `gg.cmd` from: <https://github.com/eirikb/gg#ggcmd>. `gg.cmd` is a "binary" running on macOS, Linux, and Windows. No need for different binaries on different operating systems.
+2. Run `gg.cmd`. This will download and use JBang as wrapper around running JabKit:
 
-    gg.cmd jbang jabkit@jabref --help
+    - Linux/macOS: Run `sh ./gg.cmd jbang jabkit@jabref --help`.
+    - Windows: Run `gg.cmd jbang jabkit@jabref --help`.
 
-## Running `JabSrv`
+You can also put `gg.cmd` on your `PATH` and make it executable.
+Then you enable `alias jabkit='gg.cmd jbang jabkit@jabref`.
 
-If you have JBang installed, just run `jbang jabsrv@jabref --help`
+## Running JabKit with JBang
 
-With `gg.cmd`:
+If you have JBang installed, just run
+
+```terminal
+jbang jabkit@jabref --help
+```
+
+You can also install `jabkit` permanently in your `PATH`:
+
+1. [Install JBang](https://www.jbang.dev/download/). E.g., by `brew install jbangdev/tap/jbang` or `choco install jbang`
+2. Make `jabkit` available on the command line: `jbang app install jabkit@jabref`
+3. Run `jabkit --help`
+
+[JBang takes care about updating JabKit automatically](https://github.com/orgs/jbangdev/discussions/1636#discussioncomment-6150992).
 
-    gg.cmd jbang jabsrv@jabref --help
+## Running JabSrv
+
+If you have JBang installed, just run following command
+
+```terminal
+jbang jabsrv@jabref --help
+```
+
+With `gg.cmd`:
 
+```terminal
+sh ./gg.cmd jbang jabsrv@jabref --help
+```

.vscode/ltex.dictionary.en-US.txt

@@ -1,9 +1,10 @@
 Checkstyle
 CouchDB
 JabDrive
+JabKit
 JabRef
+JabSrv
+JBang
 OpenFastTrace
 OpenRewrite
 Temurin
-
-JabKit

README.md

@@ -56,24 +56,15 @@ Please see our [Installation Guide](https://docs.jabref.org/installation).
 
 JabRef offers a CLI application.
 
-You can run it using docker:
+You can run it using JBang.
+We provide details at [`.jbang/README.md`](.jbang/README.md).
+
+You can also run JabKit using docker:
 
 ```terminal
 docker run ghcr.io/jabref/jabkit:edge --help
 ```
 
-### Running JabKit using `JBang`
-
-[`JBang`](https://www.jbang.dev/) allows for running Java applications without having a JDK installed (before).
-
-Steps:
-
-1. [Install `JBang`](https://www.jbang.dev/download/). E.g., by `brew install jbangdev/tap/jbang` or `choco install jbang`
-2. Make `jabkit` available on the command line: `jbang app install jabkit@jabref`
-3. Run `jabkit --help`
-
-Now, you have all JabKit functionality available as `jabkit`.
-
 ## Bug Reports, Suggestions, Other Feedback
 
 [![Donation](https://img.shields.io/badge/donate%20to-jabref-orange.svg)](https://donations.jabref.org)