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