New upstream release.
[debian/jabref.git] / src / windows / nsis / README.txt
1
2 JabRef Installer Documentation
3 ------------------------------
4
5 How to build the installer:
6
7   * Create a build.properties file in root-directory and set the
8     nsis.executable variable to point to makensis.exe
9   * Run the win.installer.build target from the ant-file in root-directory.
10
11 What is here?
12
13   * dist
14     * Should contain everything that is supposed to be shipped to the user.
15   * launcher.nsi - Will create the exe-wrapper.
16   * setup.nsi - Will create the installer.
17   * fileassoc.nsh - Helper script to set file-associations
18
19 Requirements + Current Status
20
21         Exe-Wrapper:
22           * Pass arguments to JabRef [done]
23           * JabRef-Ico 16x16, 32x32, 48x48 [done]
24         
25         Installer:
26           * Display GPL [done]
27           * Add file association for .bib (if desired) [done]
28           * Install into custom start-menu location (if desired) [done]
29           * Can only run as administrator [done, Uwe]
30           * Install onto desktop (if desired)
31           * Install onto quicklaunch (if desired)
32         
33         Uninstaller:
34           * Uninstaller
35             * Allow to keep configuration
36             
37         All:
38           * Localization
39           
40 Credits
41
42         Uwe Stöhr rewrote the installer and fixed a lot of issues with the old one.
43