JabRef Development Version

This version is a development version. Features may not work as expected.

The branch of this README file is master. The intention of this branch is to move JabRef forward to modern technologies such as Java8 and JavaFX.

The last version with Java6 support is v2.11 being developed at the dev_2.11 branch.

Development builds are available at builds.jabref.org, the latest release is available via GitHub.

Explanation of donation possibilities and usage of donations is available at our donations page.

We use install4j, the multi-platform installer builder.

Breaking Changes in Comparison to v2.11

• No plugin support
• Transition to Java8

Background

JabRef is a graphical Java application for editing bibtex (.bib) databases. JabRef lets you organize your entries into overlapping logical groups, and with a single click limit your view to a single group or an intersection or union of several groups. You can customize the entry information shown in the main window, and sort by any of the standard Bibtex fields. JabRef can autogenerate bibtex keys for your entries. JabRef also lets you easily link to PDF or web sources for your reference entries.

JabRef can import from and export to several formats, and you can customize export filters. JabRef can be run as a command line application to convert from any import format to any export format.

• Homepage: http://jabref.sourceforge.net/
• Development mailing list: https://lists.sourceforge.net/lists/listinfo/jabref-devel
• Development page: https://github.com/JabRef
• Main git repository: https://github.com/JabRef/jabref
• CI Server: https://circleci.com/gh/JabRef/jabref
• Open HUB page: https://www.openhub.net/p/jabref

Bug Reports, Suggestions, Other Feedback

We are thankful for any bug reports or other feedback. If there are features you want included in JabRef, tell us!

You can use our GitHub issue tracker to send in bug reports and suggestions.

To get your code added to JabRef, just fork JabRef and create a pull request. For details see CONTRIBUTING.

Installing and Running

Requirements

JabRef runs on any system equipped with the Java Virtual Machine (1.8 or newer), which can be downloaded at no cost from Oracle.

Installing and Running, Mac OS X:

Please see our Mac OS X FAQ.

Installing and Running, Windows:

JabRef offers an installer, which also adds a shortcut to JabRef to your start menu.

Please also see our Windows FAQ

Installing and Running, General:

JabRef can be downloaded as an executable .jar file. Try to double click the jar file or execute the following command: java -jar <path to jar>

Documentation

JabRef comes with an online help function, accessed by pressing F1 or clicking on a question mark icon. The help files are probably not exhaustive enough to satisfy everyone yet, but they should help sort out the most important issues about using the program. The help files can also be viewed outside the program with a standard HTML browser. If you choose languages other than English, some or all help pages may appear in your chosen languages.

Building JabRef From Source

If you want a step-by-step tutorial, please check this guideline

To compile JabRef from source, you need a Java compiler supporting Java 1.8 and JAVA_HOME pointing to this JDK. You have to set GRADLE_OPTS to -Dfile.encoding=UTF-8 as gradle uses the JVM's platform encoding.

To run it, just execute gradlew run. When you want to develop, it is necessary to generate additional sources using gradlew generateSource and then generate the Eclipse gradlew eclipse. For IntelliJ IDEA, just import the project via a Gradle Import by pointing at the build.gradle.

Release Process

Requires install4j. We've got an Open Source License.

To get a list of all targets, use gradlew tasks.

releaseJar - Creates a Jar release.
media - Creates executables and installers.

All binaries are created inside the directory build/releases.

Releasing Developer Releases

Run gradlew -Pdev=true ANY_RELEASE_TASK to execute any of the previously defined release tasks. The only difference is that the version contains the keyword snapshot, the date, the branch name, and the shortend git hash.

Normal: JabRef--3.0dev.jar With -Pdev=true: JabRef-3.0dev--snapshot--2015-11-20--master--cc4f5d1.jar

License

JabRef is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version. See the LICENSE for full details.

JabRef also uses libraries distributed by other parties. See external libraries for details.