Skip to content

Commit 9d5a042

Browse files
committed
First step using gh tool
1 parent 6a14e35 commit 9d5a042

File tree

2 files changed

+17
-10
lines changed

2 files changed

+17
-10
lines changed

en/.gitbook/assets/pr-13182.png

39.6 KB
Loading

en/contributing/README.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,9 @@ Initial setup:
2626
- Get `gg.cmd`
2727
- `wget ggcmd.io -OutFile gg.cmd`
2828
- Clone JabRef
29-
- `./gg.cmd jbang https://github.com/JabRef/jabref/blob/main/.jbang/CloneJabRef.java jabref`
30-
- Make `gg.cmd` available in `JabRef` directory
29+
- `.\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>
31+
- Make `gg.cmd` available in `jabref` source directory
3132
- `cd jabref`
3233
- `move ..\gg.cmd .`
3334
- Linux:
@@ -39,22 +40,28 @@ Initial setup:
3940
- `wget ggcmd.io/gg.cmd`
4041
- Alternative: `curl -L ggcmd.io > gg.cmd`
4142
- Clone JabRef
42-
- `sh ./gg.cmd jbang https://github.com/JabRef/jabref/blob/main/.jbang/CloneJabRef.java JabRef`
43-
- 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.
44-
- Make `gg.cmd` available in `JabRef` directory
45-
- `cd JabRef`
43+
- `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.
45+
- Make `gg.cmd` available in `jabref` source directory
46+
- `cd jabref`
4647
- `mv ../gg.cmd .`
4748

48-
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.
49+
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.
4950

5051
Try a branch:
5152

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).
53+
1. `cd` into the `jabref` source directory: `cd c:\git-repositories\jabref`
54+
2. Checkout out the pull request: `sh ./gg.cmd gh pr checkout 13182` - where `13182` is the PR number, in this case [pr#13182](https://github.com/JabRef/jabref/pull/13182).
5455
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.
5556

5657
On Windows, instead of `sh ./gg.cmd` use `.\gg.cmd`.
5758

59+
Instead of the number, you can also copy and paste the branch identifier output by GitHub.
60+
61+
![pr-13182](../.gitbook/assets/pr-13182.png)
62+
63+
In this case, you can run `sh ./gg.cmd gh pr checkout Yubo-Cao:walkthrough`
64+
5865
Alternatives:
5966

6067
1. In case you don't want to use `gg.cmd`:
@@ -68,7 +75,7 @@ Alternatives:
6875

6976
Please see [How to Improve the Help Page](how-to-improve-the-help-page.md)
7077

71-
**I would like to help translating JabRef to another language.**
78+
**I would like to help to translate JabRef to another language.**
7279

7380
We encourage you to read about [translating the JabRef user interface](how-to-translate-the-ui.md).
7481

0 commit comments

Comments
 (0)