You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* More easy run
* Try to have image on next line
* Use "just" instead of "gh/casey/just"
* Update en/contributing/README.md
Co-authored-by: Subhramit Basu <subhramit.bb@live.in>
* Refine README.md
* Apply suggestions from code review
Co-authored-by: Subhramit Basu <subhramit.bb@live.in>
---------
Co-authored-by: Subhramit Basu <subhramit.bb@live.in>
-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` to achieve the same result.
31
33
- Make `gg.cmd` available in `jabref` source directory
32
34
-`cd jabref`
33
35
-`move ..\gg.cmd .`
@@ -39,33 +41,46 @@ In the following, we try to give a minimal set of installation instructions to b
- 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` to achieve the same result.
45
49
- Make `gg.cmd` available in `jabref` source directory
46
50
-`cd jabref`
47
51
-`mv ../gg.cmd .`
48
52
49
53
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.
50
54
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
+
51
57
### Try a branch
52
58
53
59
1.`cd` into the `jabref` source directory: `cd c:\git-repositories\jabref`
54
-
2. Checkout out the pull request: `sh ./gg.cmd jbang https://github.com/JabRef/jabref/blob/main/.jbang/CheckoutPR.java 13182` - where `13182` is the PR number, in this case [pr#13182](https://github.com/JabRef/jabref/pull/13182).
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
55
61
56
-
- Instead of the number, you can also copy and paste the branch identifier output by GitHub: `sh ./gg.cmd jbang https://github.com/JabRef/jabref/blob/main/.jbang/CheckoutPR.java Yubo-Cao:walkthrough`.
62
+
- Example: `13182` for [pr#13182](https://github.com/JabRef/jabref/pull/13182).
63
+
- Example: `Yubo-Cao:walkthrough` for the branch identifier output by GitHub\
57
64

58
65
59
-
3. Compile and run JabRef: `sh ./gg.cmd gradle run :jabgui:run`. This will also download the necessary JDK and a gradle distribution. On the first run, please give the system enough time to accommodate and wait until the JabRef window launches. Depending on your hardware, this may take a few minutes.
66
+
This will download the necessary JDK and a gradle distribution.
67
+
On the first run, please give the system enough time to accommodate and wait until the JabRef window launches.
68
+
Depending on your hardware, this may take a few minutes.
69
+
70
+
On Windows, instead of `sh ./gg.cmd` use `.\gg.cmd`:
60
71
61
-
On Windows, instead of `sh ./gg.cmd` use `.\gg.cmd`.
72
+
.\gg.cmd just run-pr <pr-number>
62
73
63
74
#### Alternatives
64
75
65
-
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.
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
- 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`.
69
84
- 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).
70
85
71
86
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