Skip to content

Commit 3aa44db

Browse files
espertuskoppor
andauthored
Fix build instructions (#579)
Co-authored-by: Oliver Kopp <kopp.dev@gmail.com>
1 parent ca0f7b6 commit 3aa44db

1 file changed

Lines changed: 13 additions & 6 deletions

File tree

en/installation.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -136,19 +136,26 @@ This is one the one hand a font problem and second a lognstanding [JavaFX bug](h
136136
{% endtab %}
137137
{% endtabs %}
138138

139-
## Building From Source
139+
## Building from source
140140

141141
This method is mainly for package maintainers and users who would like to build the latest snapshots of JabRef directly from the source. If you want to setup JabRef for development, follow the instructions for [setting up a workspace](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace).
142142

143-
To build JabRef from source, you first need to have a working Java Development Kit (see above link for details) and Git installed on your system. After installing the two requirements, you open a terminal window (i.e., a command prompt) and type the following:
143+
To build JabRef from source, you first need to have a working Java Development Kit (see above link for details) and Git installed on your system. After installing the requirements, you open a terminal window (i.e., a command prompt) and type the following:
144144

145145
```shell
146146
git clone --recurse-submodules --depth=10 https://github.com/JabRef/jabref
147147
cd jabref
148-
./gradlew assemble
149-
./gradlew jlink
148+
./gradlew :jabgui:jpackage
150149
```
151150

152-
In a nutshell, you clone the latest snapshot of JabRef into `jabref` directory, change directory to `jabref`, initialize and update all the submodules (dependencies) of JabRef, assemble them to be built via JDK and finally build and link them together.
151+
In a nutshell, you clone the latest snapshot of JabRef into `jabref` directory, initialize and update all its submodules, change directory to `jabref`, and build the application.
153152

154-
The output should be the `jabgui/build/image` subdirectory that contains the JabRef binary with all of its Java dependencies. To start JabRef, you need to run `bin/JabRef` (in Linux and MacOS) or `bin/JabRef.bat` (in Windows) under `jabgui/build/image` subdirectory.
153+
The executable file will be written to an OS-specific subdirectory of `jabgui/build/packages`. On Windows, this would be `jabgui/build/packages/windows-latest/JabRef/JabRef.exe`.
154+
155+
## Running from source
156+
157+
To run from source without building an executable, type the following in a terminal window:
158+
159+
```shell
160+
./gradlew :jabgui:run
161+
```

0 commit comments

Comments
 (0)