florian-beetz / jabref

Graphical Java application for managing BibTeX and BibLaTeX (.bib) databases
https://www.jabref.org
MIT License
0 stars 0 forks source link

JabRef Bibliography Management

Build Status codecov.io Donation

JabRef is an open-source, cross-platform citation and reference management tool licensed under the MIT license.

Stay on top of your literature: JabRef helps you to collect and organize sources, find the paper you need and discover the latest research. main table

Features

JabRef is a cross-platform application that works on Windows, Linux and Mac OS X. It is available free of charge and is actively developed. JabRef supports you in every step of your research work.

Collect

Organize

Cite

Share

Installation

Fresh development builds are available at builds.jabref.org. The latest stable release is available at FossHub.

JabRef runs on any system equipped with the Java Virtual Machine (1.8), which can be downloaded at no cost from Oracle. Note that Java 9 is currently not supported. From JabRef 4.0 onwards, JavaFX support has to be installed.

In addition, 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>

Bug Reports, Suggestions, Other Feedback

Donation

We are thankful for any bug reports or other feedback. If you have ideas for new features you want to be included in JabRef, tell us in our forum! If you need support in using JabRef, please read the documentation first and have a look at our community forum. You can use our GitHub issue tracker to file bug reports.

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

Contributing

Help Contribute to Open Source Join the chat at https://gitter.im/JabRef/jabref OpenHub

Not a programmer? Learn how to help.

Want to be part of a free and open-source project that tens of thousands scientist use every day? Check out our issue tracker to find something to work on. You are also welcome to contribute new features. To get your code included into JabRef, just fork JabRef and create a pull request. For details have a look at our guidelines for contributing. We view pull requests as a collaborative process. Submit a pull request early to get feedback from the team on work in progress. We will discuss improvements with you and agree to merge them once the developers approve.

If you want a step-by-step walk-through on how to set-up your workspace, 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.

gradlew test executes the normal unit tests. If you want to test the UI, execute gradlew integrationTest. Sources for the integration test are kept in src/integrationTest.

Acknowledgements

We use install4j, the multi-platform installer builder. We've got an open-source license.

License

Since version 3.6, JabRef is licensed under the MIT license. See the LICENSE.md for the full MIT license.

JabRef also uses libraries, fonts, and icons distributed by other parties. See external libraries for details.