Skip to content

Commit 98e2f71

Browse files
committed
Refine README.md
1 parent fd0e936 commit 98e2f71

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

en/contributing/README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,11 @@ In the following, we try to give a minimal set of installation instructions to b
2525
- `cd c:\git-repositories`
2626
- Get `gg.cmd`
2727
- `wget ggcmd.io -OutFile gg.cmd`
28+
- Have JBang trusting JabRef's code
29+
- `.\gg.cmd jbang trust add https://github.com/JabRef/jabref/`
2830
- Clone JabRef
2931
- `.\gg.cmd jbang https://github.com/JabRef/jabref/blob/main/.jbang/CloneJabRef.java jabref`
30-
- When JBang asks you for trust, you can choose "Trust once" by pressing <kbd>1</kbd> and then <kbd>Enter</kbd>
32+
- NOTE: You can also use the native git client: `git clone --recurse-submodules https://github.com/JabRef/jabref.git` for achieving the same result.
3133
- Make `gg.cmd` available in `jabref` source directory
3234
- `cd jabref`
3335
- `move ..\gg.cmd .`
@@ -39,19 +41,23 @@ In the following, we try to give a minimal set of installation instructions to b
3941
- Get `gg.cmd` (using either `wget` or `curl`)
4042
- `wget ggcmd.io/gg.cmd`
4143
- Alternative: `curl -L ggcmd.io > gg.cmd`
44+
- Have JBang trusting JabRef's code
45+
- `sh ./gg.cmd jbang trust add https://github.com/JabRef/jabref/`
4246
- Clone JabRef
4347
- `sh ./gg.cmd jbang https://github.com/JabRef/jabref/blob/main/.jbang/CloneJabRef.java jabref`
44-
- NOTE: You can also use the native git client: `git clone --recurse-submodules https://github.com/JabRef/jabref.git jabref` for achieving the same result.
48+
- NOTE: You can also use the native git client: `git clone --recurse-submodules https://github.com/JabRef/jabref.git` for achieving the same result.
4549
- Make `gg.cmd` available in `jabref` source directory
4650
- `cd jabref`
4751
- `mv ../gg.cmd .`
4852

4953
Now you are all set: You have a directory `jabref` containing the recent updates and also `gg.cmd` which you will need later for executing a JabRef build.
5054

55+
Note: If you don't want to store JabRef's source code permanently, you can follow the steps at [our blog post on gg.cmd usage](https://blog.jabref.org/2025/05/31/run-pr/). There, JabRef's source is checked out in a temporary directory.
56+
5157
### Try a branch
5258

5359
1. `cd` into the `jabref` source directory: `cd c:\git-repositories\jabref`
54-
2. Checkout the PR and run JabRef: `sh ./gg.cmd just run-pr xyz` - replace `xyz` with the PR number or the unique branch identifier by GitHub
60+
2. Checkout the PR and run JabRef: `sh ./gg.cmd just run-pr <pr-number>` - replace `<pr-number>` with the PR number or the unique branch identifier by GitHub
5561

5662
- Example: `13182` for [pr#13182](https://github.com/JabRef/jabref/pull/13182).
5763
- Example: `Yubo-Cao:walkthroug` for the branch identifier output by GitHub\
@@ -61,18 +67,20 @@ This will download the necessary JDK and a gradle distribution.
6167
On the first run, please give the system enough time to accommodate and wait until the JabRef window launches.
6268
Depending on your hardware, this may take a few minutes.
6369

64-
On Windows, instead of `sh ./gg.cmd` use `.\gg.cmd`.
70+
On Windows, instead of `sh ./gg.cmd` use `.\gg.cmd`:
71+
72+
.\gg.cmd just run-pr <pr-number>
6573

6674
#### Alternatives
6775

68-
1. In case you don't want to use `gg.cmd`: You can install [JBang](https://www.jbang.dev/) and a [Java JDK](https://adoptium.net/de/temurin/releases/?os=any&arch=any&version=21) for yourself and execute the commands directly. These are
76+
1. In case you don't want to use `gg.cmd`: You can install [JBang](https://www.jbang.dev/) for yourself and execute the commands directly. These are
6977

70-
- `jbang https://github.com/JabRef/jabref/blob/main/.jbang/CheckoutPR.java {{pr-id}}`
78+
- `jbang https://github.com/JabRef/jabref/blob/main/.jbang/CheckoutPR.java <pr-number>`
7179
- `./gradlew :jabgui:run`
7280

7381
2. In case you don't want to use `JBang`:
7482

75-
- You have the project clone ready and have some Java JDK available: In the `jabref` directory, execute `./gradlew run`.
83+
- You have the project clone ready and have some [Java JDK](https://adoptium.net/de/temurin/releases/?os=any&arch=any&version=21) available: In the `jabref` directory, execute `./gradlew run`.
7684
- Install `gh` (the [GitHub CLI](https://cli.github.com/), a command-line client for GitHub) by using the installer linked on their [homepage](https://cli.github.com/) or the commands given at the [installation hints](https://github.com/cli/cli#installation).
7785

7886
3. In case you don't want to use `gh`: You can use the "usual" `git clone ...`, `git remote add ...`, `git fetch ...`, and `git checkout ...` commands to checkout a pull request from a fork.

0 commit comments

Comments
 (0)