Imported Upstream version 2.10+ds
[debian/jabref.git] / src / txt / README
1 JabRef 2.10 development version
2 -------------------------------
3 This version is a development version. Features may not work as expected.
4
5 Introduction:
6
7 JabRef is a graphical Java application for editing bibtex (.bib)
8 databases. JabRef lets you organize your entries into overlapping
9 logical groups, and with a single click limit your view to a single
10 group or an intersection or union of several groups. You can customize
11 the entry information shown in the main window, and sort by any of the
12 standard Bibtex fields. JabRef can autogenerate bibtex keys for your
13 entries. JabRef also lets you easily link to PDF or web sources for your
14 reference entries.
15
16 JabRef can import from and export to several formats, and you can
17 customize export filters. JabRef can be run as a command line application
18 to convert from any import format to any export format.
19
20
21 License:
22 JabRef is free software: you can redistribute it and/or modify it under the
23 terms of the GNU General Public License as published by the Free Software
24 Foundation, either version 2 of the License, or (at your option) any later
25 version.  dialog, for details about the GPL. See the enclosed text files
26 'gpl2.txt' and 'gpl3.txt' for the full details.
27
28 JabRef also uses libraries distributed by other parties; see the About
29 box for details.
30
31
32 Requirements:
33 JabRef runs on any system equipped with the Java Virtual Machine
34 (1.5 or newer), which can be downloaded at no cost from
35 http://java.sun.com. If you do not plan to compile JabRef, the Java
36 Runtime Environment may be a better choice than the Java Development
37 Kit.
38
39
40 Installing and running, Windows:
41 JabRef is available in Windows Installer (.msi) format. To install,
42 double-click the .msi file. A shortcut to JabRef will be added to your
43 start menu.
44
45 The Windows installation was made by Dale Visser, using the following open-source tools:
46 JSmooth (.exe wrapper for Java apps), available at http://jsmooth.sf.net/
47 Wix (tool for compiling MSI files from an XML specification), available at http://wix.sf.net/
48
49
50 Installing and running, general:
51 JabRef can be downloaded as an executable .jar file. Run the
52 program as follows:
53 If you are using the Java Development Kit:
54      java -jar <path to jar>
55 or, if you are using the Java Runtime Environment:
56      jre -new -jar <path to jar> or
57      jrew -new -jar <path to jar>
58
59 If you run JabRef under Java 1.5, you can add the option "-Dswing.aatext=true" before the
60 "-jar" option, to activate antialiased text throughout the application.
61
62
63 The jar file containing JabRef can be unpacked with the command:
64     jar xf <path to jar>
65 or  jar xf <path to jar> <list of files to extract>
66 Unpacking the jar file is not necessary to run the program.
67
68
69
70 Building JabRef from source:
71 Please see the INSTALL file for instructions for building from source.
72
73 Documentation:
74 JabRef comes with an online help function, accessed by pressing F1 or
75 clicking on a question mark icon. The help files are probably not
76 exhaustive enough to satisfy everyone yet, but they should help sort
77 out the most important issues about using the program. The help files
78 can also be viewed outside the program with a standard HTML browser.
79 If you choose languages other than English, some or all help pages may
80 appear in your chosen languages.
81
82
83 Bug reports, suggestions, other feedback:
84 We are thankful for any bug reports or other feedback. If there are
85 features you want included in JabRef, tell us!
86
87
88 JabRef homepage:
89 http://jabref.sourceforge.net
90
91 You can always get the very latest version of the program from our SVN
92 repository; instructions for downloading are found on the
93 homepage. Note that the SVN version may contain untested features, or
94 have other stability issues.
95
96 Bug submission and Open Discussions and Help forums are found at:
97 http://sourceforge.net/projects/jabref
98
99
100 Corresponding authors:
101 mortenalver _ users.sourceforge.net
102 nbatada _ users.sourceforge.net