Skip to content

Commit 2a89e3c

Browse files
authored
Refine gg instructions
1 parent b30406a commit 2a89e3c

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

en/contributing/README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ In the following, we try to give a minimal set of installation instructions to b
1414

1515
Required tooling:
1616

17-
- [GitHubCLI](https://cli.github.com/) - A command-line client for GitHub. You can install it 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).
1817
- [`gg.cmd`](https://github.com/eirikb/gg) - A cross-platform and cross-architecture version manager. Download [`gg.cmd`](https://github.com/eirikb/gg/releases/latest/download/gg.cmd) and store it in your home (or `Downloads`) directory.
1918

2019
Initial setup:
@@ -27,9 +26,9 @@ Initial setup:
2726
- Get `gg.cmd`
2827
- `wget ggcmd.io -OutFile gg.cmd`
2928
- Clone JabRef
30-
- `./gg.cmd jbang https://github.com/JabRef/jabref/blob/main/.jbang/CloneJabRef.java JabRef`
29+
- `./gg.cmd jbang https://github.com/JabRef/jabref/blob/main/.jbang/CloneJabRef.java jabref`
3130
- Make `gg.cmd` available in `JabRef` directory
32-
- `cd JabRef`
31+
- `cd jabref`
3332
- `move ..\gg.cmd .`
3433
- Linux:
3534
- Open a shell
@@ -50,14 +49,18 @@ Now you are all set: You have a directory `JabRef` containing the recent updates
5049

5150
Try a branch:
5251

53-
1. `cd` into the `JabRef` directory: `cd c:\git-repositories\JabRef`
54-
2. Checkout out the pull request: `gh pr checkout 13111` - where `13111` is the PR number, in this case [pr#13111](https://github.com/JabRef/jabref/pull/13111).
55-
3. Compile and run JabRef: `gg.cmd gradle run :jabgui:run` (on Linux and macOS, you need to prefix it with `sh`: `gg.cmd gradle run :jabgui:run`). This will also download the necessary JDK and 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 minutes.
52+
1. `cd` into the `jabref` directory: `cd c:\git-repositories\jabref`
53+
2. Checkout out the pull request: `sh ./gg.cmd gh pr checkout 13111` - where `13111` is the PR number, in this case [pr#13111](https://github.com/JabRef/jabref/pull/13111).
54+
3. Compile and run JabRef: `sh ./gg.cmd gradle run :jabgui:run` (on Linux and macOS, you need to prefix it with `sh`: `gg.cmd gradle run :jabgui:run`). This will also download the necessary JDK and 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 minutes.
55+
56+
On Windows, instead of `sh ./gg.cmd` use `.\gg.cmd`.
5657

5758
Alternatives:
5859

59-
1. You don't want to use `gg.cmd`: You have the project clone ready and have some Java JDK available: In the `JabRef` directory, execute `./gradlew run`.
60-
2. You don't want to use GitHub's `gh` tool: You can use the "usual" `git clone ...`, `git remote add ...`, `git fetch ...`, and `git checkout ...` commands to checkout a pull request from a fork.
60+
1. In case you don't want to use `gg.cmd`:
61+
- You have the project clone ready and have some Java JDK available: In the `JabRef` directory, execute `./gradlew run`.
62+
- Install [GitHubCLI](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).
63+
2. In case you don't want to use GitHub's `gh` tool: You can use the "usual" `git clone ...`, `git remote add ...`, `git fetch ...`, and `git checkout ...` commands to checkout a pull request from a fork.
6164

6265
**I would like to improve the help page.**
6366

0 commit comments

Comments
 (0)