installer: sync with branch
[lyx.git] / development / Win32 / packaging / AltInstaller / ReadmeSmall1.6.txt
blobe620d05cc629d20c2f0f0e1c21ca78ec54caa357
1 Description
3 This is the readme of the variant "small" of the LyXWinInstaller. Please read
4 this file carefully to prevent troubles with the installer.
5 The LyXWinInstaller installs the wordprocessor "LyX" (www.lyx.org) and some
6 needed programs on Windows 2000/XP/XPx64/Vista/7.
7 ! Win95, Win98, and WinME are NOT supported. !
9 ---
10 General
12 The installer variant "small" has the same functionality as the "complete" version
13 but doesn't include the LaTeX-distribution MiKTeX. It checks your system for an
14 installed version of MiKTeX (www.miktex.org) or TeXLive (http://www.tug.org/texlive/).
16 The installer provides an option to to choose a LaTeX-distribution from a network
17 drive or a live-CD/DVD and an option to not use LyX with LaTeX.
19 ---
20 Prerequisites
22 To use the installer you need administrator privileges.
23 An open internet connection is recommended as several LaTeX-packages and
24 spellchecker dictionaris can than be downloaded and installed automatically.
26 It is not essential but would be an advantage if you have the PDF-viewer
27 "Adobe Reader" installed before running the installer.
29 ---
30 Installed Applications
32 The variant "small" of the LyXWinInstaller analyses your system and installs,
33 if needed, a fully functional version of:
35 - Aspell, a spellchecker
36 - Ghostscript, an interpreter for Postscript and PDF
37 - ImageMagick, an image converter
38 - eLyXer, a LyX to HTML converter
40 ImageMagick and Ghostscript won't appear in the list of the installed programs
41 in Window's system control because they are installed in a special version to 
42 use them with LyX. But if you decide to install another version of the programs
43 you can do this without problems and without uninstalling LyX.
44 If you want to install GSview manually later you can do this without a new
45 installation of Ghostscript.
46 If Python is installed on the system, elyXer is installed as Python module.
48 ---
49 After the Installation
51 To view/edit external files like images LyX uses the default program set in the registry
52 for a file extension. This installer checks for many programs so that you only need to type
53 the name of their executables in LyX's preferences to change this.
54 For example the default viewer for PNG-images on Windows is "Paint". To change it to Gimp,
55 set e.g. "gimp-2.2" as viewer/editor for the PNG file format in LyX's preferences.
57 ---
58 Known Problems
60 You can't install LyX to a folder that has accents or umlauts in its name.
62 If you use LyX with a computer user account that has accents or umlauts in its name,
63 change LyX's paths in the menu Edit -> Preferences so that they don't contain accents
64 and restart LyX.
66 The live-variant of TeX-Live don't work together with LyX due to incompatible Ghostscript
67 and dv2dt/dt2dv versions.
68 TeX-Live will only work together with LyX when it is installed without Ghostscript.
70 ---
71 The Uninstaller
73 LyXWinInstall's uninstaller uninstalls LyX. Aspell, Ghostscript, GSview, ImageMagick, JabRef,
74 and MiKTeX are only uninstalled when they were installed together with LyX. You can uninstall
75 Aspell, GSview, JabRef, and MiKTeX also separately via Window's Software menu in the system
76 control.
78 ---
79 Internationalization
81 The installer language string files can be found in the subfolder
82 "lyx_languages" of the sourcecode package:
83 https://developer.berlios.de/project/showfiles.php?group_id=5117
85 If you want to help the project you can translate them or create a new language
86 string file based on the file "english.nsh".
87 Please send the modified files as patch to
88 http://developer.berlios.de/patch/?group_id=5117
89 or to
90 uwestoehr<at>web.de.
92 ---
93 License
95 The scripts of the LyXWinInstaller are released under the GNU General Public
96 License (GPL). A package with the sourcecode can be found
97 in the section "LyxWinInstallerSource" of
98 http://developer.berlios.de/project/showfiles.php?group_id=5117
100 The license files of all used programs can be found in the subdirectory "bin"
101 of LyX's installation folder.