Merge tag 'debian/2.10+ds-4'
[debian/jabref.git] / README.md
index 7ba7b8f41d17428f607a5d7e453ab86b7a0ff127..2fcf203c1e5bebdaae0fd039c1beaaee195284cc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,9 @@
-# JabRef version 2.11 beta
+# JabRef 2.11 beta 3
+
+[![Build Status](https://api.travis-ci.org/JabRef/jabref.png?branch=master)](https://travis-ci.org/JabRef/jabref)
+[![Dependency Status](https://www.versioneye.com/user/projects/557f2723386664002000009c/badge.svg?style=flat)](https://www.versioneye.com/user/projects/557f2723386664002000009c)
+[![Coverage Status](https://coveralls.io/repos/JabRef/jabref/badge.svg)](https://coveralls.io/r/JabRef/jabref)
+[![Join the chat at https://gitter.im/JabRef/jabref](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/JabRef/jabref?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 This version is a beta version. Features may not work as expected.
 
@@ -12,6 +17,7 @@ JabRef can import from and export to several formats, and you can customize expo
 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 mailinglist: 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://travis-ci.org/JabRef/jabref
@@ -34,9 +40,7 @@ The "old" trackers at sourceforge still remain intact:
 
 Do *not* file patches using https://sourceforge.net/p/jabref/patches/.
 Just fork JabRef and create a pull request.
-
-For newcomers, [FLOSS Coach](http://www.flosscoach.com/) might be helpful. It contains steps to get start with JabRef development.
-
+For details see [CONTRIBUTING.md](CONTRIBUTING.md).
 
 ### Next Steps
 
@@ -47,39 +51,31 @@ For newcomers, [FLOSS Coach](http://www.flosscoach.com/) might be helpful. It co
 
 ## Requirements
 
-JabRef runs on any system equipped with the Java Virtual Machine (1.6 or newer), which can be downloaded at no cost from http://java.sun.com.
+JabRef runs on any system equipped with the Java Virtual Machine (1.6 or newer), which can be downloaded at no cost from [Oracle](http://www.oracle.com/technetwork/java/javase/downloads/index.html).
 If you do not plan to compile JabRef, the Java Runtime Environment may be a better choice than the Java Development Kit.
 
 
+## Installing and running, Mac OS X:
+
+Please see our [Mac OS X FAQ](http://jabref.sourceforge.net/faq.php#osx).
+
+
 ## Installing and running, Windows:
 
-JabRef is available in Windows Installer (`.msi`) format. To install,
-double-click the .msi file. A shortcut to JabRef will be added to your
-start menu.
+JabRef offers an installer, which also adds a shortcut to JabRef to your start menu.
 
-The Windows installation was made by Dale Visser, using the following open-source tools:
-JSmooth (.exe wrapper for Java apps), available at http://jsmooth.sf.net/
-Wix (tool for compiling MSI files from an XML specification), available at http://wix.sf.net/
+Please also see our [Windows FAQ](http://jabref.sourceforge.net/faq.php#windows)
 
 
 ## Installing and running, general:
 
-JabRef can be downloaded as an executable .jar file. Run the
-program as follows:
-If you are using the Java Development Kit:
+JabRef can be downloaded as an executable .jar file.
+Try to doubleclick the `jar` file or execute the follwing command:
      `java -jar <path to jar>`
-or, if you are using the Java Runtime Environment:
-     `jre -new -jar <path to jar>` or
-     `jrew -new -jar <path to jar>`
 
 If you run JabRef under Java 1.5, you can add the option `-Dswing.aatext=true` before the
 `-jar` option, to activate antialiased text throughout the application.
 
-The jar file containing JabRef can be unpacked with the command:
-    `jar xf <path to jar>`
-or  `jar xf <path to jar> <list of files to extract>`.
-Unpacking the jar file is not necessary to run the program.
-
 
 ## Documentation
 
@@ -105,9 +101,12 @@ and then generate the Eclipse `gradlew eclipse` or IntelliJ IDEA `gradlew idea`
 
 ## Release Process
 
-Requires [NSIS](http://nsis.sourceforge.net) with the [WinShell plug-in](http://nsis.sourceforge.net/WinShell_plug-in).
+Requires
+ * [launch4j](http://launch4j.sourceforge.net/)
+ * [NSIS](http://nsis.sourceforge.net) with the [WinShell plug-in](http://nsis.sourceforge.net/WinShell_plug-in).
+ * Eventually a `user.properties` with correct setting of `launch4j.dir` and `nsis.executable`. See [build.xml](build.xml) for defaults.
 
-Replace `ANY_ANT_TARGET` with the Ant Target of your choice, and the system will build your binaries.
+Replace `ANY_ANT_TARGET` with the Ant Target of your choice (e.g., `macbundle`), and the system will build your binaries.
 To get a list of all targets, use `gradlew tasks`.
 
 `gradlew generateSource antTargets.ANY_ANT_TARGET`
@@ -118,11 +117,12 @@ named `JabRef-$VERSION.jar` (where $VERSION is the current version of the
 source tree) in the `buildant\lib` directory. Enjoy!
 The setup files are created by invoking the command `gradlew generateSource antTargets.release`.
 
-On Mac OS X you should include the targets osx and osxjar,
-making the correct command `gradlew generateSource antTargets.compile antTargets.unjarlib antTargets.osx antTargets.jars antTargets.osxjar`.
-After the build is finished, you will find the OS X application
-`JabRef.app` in the `buildant/lib` directory along with the executable
-jar.
+
+### Releasing on Linux
+
+Run `gradlew antTargets.release.linux`
+
+All binaries (including OSX) and the installer are generated in the directory `buildant/lib`.
 
 
 ### Releasing on Windows
@@ -136,8 +136,8 @@ All binaries (including OSX) and the installer are generated in the directory `b
 
 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 3 of the License, or (at your option) any later
+Foundation, either version 2 of the License, or (at your option) any later
 version.
-See the enclosed text files 'gpl3.txt' for full details.
+See the enclosed text files [gpl2.txt](gpl2.txt) and [gpl3.txt](gpl3.txt) for full details.
 
 JabRef also uses libraries distributed by other parties; see the About box for details.