Skip to content

Commit 725005a

Browse files
kopporsubhramit
andauthored
Update READMEs with jablib details (#14511)
Co-authored-by: Subhramit Basu <[email protected]>
1 parent 10762da commit 725005a

File tree

3 files changed

+36
-0
lines changed

3 files changed

+36
-0
lines changed

jablib-examples/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,13 @@
11
# `jablib` examples
22

3+
## Maven
4+
5+
The subdirectory [`maven3`](maven3/) contains minimal Maven-based projects showing the use of `jablib` in Java projects.
6+
7+
## JBang
8+
9+
[JBang](https://www.jbang.dev/) is a tool in the Java ecosystem to enable self-contained `.java` to be executed.
10+
It fetches all declared dependencies and runs the whole package.
11+
312
The subdirectory [`jbang`](jbang/) contains rather minimal `.java` files showing how `jablib` can be used in Java projects.
413
The code is intended as code-snippets to be used and modified as required.

jablib-examples/jbang/README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,27 @@
22

33
This directory contains [`JBang`](https://www.jbang.dev/) examples to show how to use some `jablib` features.
44

5+
## Running the examples
6+
7+
In case you have [Node.js](https://nodejs.org/) installed:
8+
9+
```terminal
10+
npx @jbangdev/jbang doi_to_bibtex.java
11+
```
12+
13+
In case, you don't have node installed, you can [download gg.cmd](https://github.com/eirikb/gg/releases/latest/download/gg.cmd) and then run `sh -x gg.cmd jbang doi_to_bibtex.java` on Linux.
14+
On Windows, it is:
15+
16+
```cmd
17+
.\gg.cmd jbang doi_to_bibtex.java
18+
```
19+
20+
You can also [download and install JBang](https://www.jbang.dev/download/) and then just run:
21+
22+
```terminal
23+
jbang doi_to_bibtex.java
24+
```
25+
526
## Development
627

728
In case you need to modify `jablib`, you can do it while working on your script.

jablib/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# `jablib`
22

3+
`jablib` offers JabRef's model and logic code as a Java library.
4+
All code in `src/main/java` is published as a Maven artifact at `org.jabref:jablib`.
5+
Example code is made available at <https://github.com/JabRef/jabref/tree/main/jablib-examples>.
6+
7+
You can browse JavaDoc at APIdia: <https://apidia.net/java/JabRef/6.0-snapshot-2025-12-02/?cls=org.jabref.jablib-module>.
8+
39
## Development information
410

511
### Publish on Maven Central

0 commit comments

Comments
 (0)