README

   1 What is LyX?
   2
   3         LyX is an advanced, open-source "document processor". Unlike
   4         standard word processors, LyX encourages writing based on the
   5         structure of your documents, not their appearance. It lets you
   6         concentrate on writing, leaving details of visual layout to the
   7         software.
   8
   9         You can read more about this concept in the documentation,
  10         which you'll find under the Help menu.  If you plan to use LyX,
  11         you really should read about it to be able to make the best of
  12         it.
  13
  14 What is LyX not?
  15
  16         LyX is not just another word processor that claims to be a
  17         Desktop Publishing program.  It's a more modern way of
  18         creating documents that look much nicer, but without wasting
  19         time with layout-fiddling.  For these reasons you might need
  20         a little time to get used to the differences.
  21         If you are looking for a free Desktop Publishing program for
  22         Unix, you will be disappointed.
  23
  24 What do I need to run LyX?
  25
  26         Either of :
  27         * a Unix-like system (or Windows with cygwin, OS/2 with XFree)
  28           with at least X11R5
  29         * Windows 98 or newer
  30         * Mac OS 10.2 or newer
  31
  32         A decent LaTeX2e installation (e.g. teTeX for unix) not older
  33            than 1995/12/01.
  34         Python 1.5.2 or later to convert old LyX files
  35
  36 How does the LyX version scheme work?
  37
  38         LyX uses a continuous numbering scheme in which odd or
  39         even numbering is not significant. Instead a number '1.x.y'
  40         indicates stable release '1.x', fix level 'y'. Prereleases
  41         are labeled with a "pre" suffix. Thus there are three possible
  42         file names:
  43
  44            lyx-1.4.0.tar.gz       -- stable release
  45            lyx-1.4.5.tar.gz       -- fifth maintenance release of the
  46                                      1.4 stable release
  47            lyx-1.4.0pre1.tar.gz   -- potentially unstable test release
  48
  49         The maintenance releases are designed primarily to fix bugs. The
  50         goal here is not to have parallel development as for the linux
  51         kernel (the team is too small to afford that), but rather to
  52         include all the simple (so that the maintenance burden on us
  53         is not too high) and safe (so that system administrators can
  54         install them without fear) bug fixes.  Experience shows that
  55         these releases will contain a few new features, and that the
  56         bulk of the patches will be documentation updates.
  57
  58         If you get the source from cvs, the version string will look like
  59         one of:
  60
  61            1.4.1cvs     -- this is the stable branch on which maintenance
  62                            release 1.4.1 will eventually be tagged.
  63            1.5.0cvs     -- this is the main branch on which stable
  64                            release 1.5.0 will eventually be tagged.
  65
  66 What's new?
  67
  68         Read NEWS.
  69
  70 How do I install .tar.gz a binary distribution of LyX?
  71
  72         Unpack it and run it.  We recommend unpacking it in /usr/local,
  73         but it should work anywhere.  In particular, you can try LyX
  74         in a temporary directory 'my_bin' before installing permanently
  75         by typing "my_bin/lyx".
  76
  77         You should read the notes regarding this particular build in
  78         the file README.bin.
  79
  80 How do I upgrade from an earlier LyX version?
  81
  82         Read the file UPGRADING for info on this subject.
  83
  84 What do I need to compile LyX from the source distribution?
  85
  86         * A good C++ compiler.  Development is being done mainly with
  87           gcc/g++, but some others work also. As of LyX 1.4.0, you need at
  88           least gcc 3.x.
  89
  90         Either:
  91         * The Xforms library, version 1.0.
  92         * LibXpm, version 4.7 or newer.
  93
  94         Or:
  95         * The Qt library, version 3.0 or newer (although version 2.3
  96         may work).
  97
  98         Read the file "INSTALL" for more information on compiling.
  99
 100 Okay, I've installed LyX. What now?
 101
 102         Once you've installed it, and everything looks fine, go read
 103         the "Introduction" item under the Help menu.  You should follow
 104         the instructions there, which tell you to read (or at least skim)
 105         the Tutorial. After that, you should also read "Help>LaTeX
 106         configuration" which provides info on your LaTeX configuration
 107         as LyX sees it.  You might be missing a package or two that you'd
 108         like to have.
 109
 110         User-level configuration is possible via the Edit>Preferences menu.
 111
 112 Does LyX have support for non-English speakers/writers/readers?
 113
 114         Yes. LyX supports writing in many languages, including
 115         right-to-left languages like Arabic or Hebrew. There is a port
 116         of LyX named CJK-LyX which adds support for Chinese, Korean
 117         and Japanese (http://cellular.phys.pusan.ac.kr/cjk.html)
 118
 119         Menus and error messages have been translated to the following
 120         languages (* means there are language-specific keyboard menu
 121         bindings as well):
 122
 123         French      (fr)
 124         Spanish     (es)
 125         Italian     (it)
 126         Danish      (da)
 127         Basque      (eu)
 128         Nynorsk     (nn)
 129         Finnish     (fi)    *
 130         German      (de)    *
 131         Russian     (ru)
 132         Polish      (pl)
 133         Slovak      (sk)
 134         Slovenian   (sl)
 135         Romanian    (ro)
 136         Norwegian   (no)
 137         Dutch       (nl)
 138
 139         Keymaps can ease typing in one or more of the following languages:
 140
 141         Arabic
 142         Bulgarian
 143         Czech
 144         French, Swiss French
 145         German, Swiss German
 146         Greek
 147         Hebrew
 148         Hungarian (Magyar)
 149         Latvian
 150         Polish
 151         Portugese
 152         Romanian
 153         Slovenian
 154         Turkish
 155         Ukrainian
 156
 157 Internet resources of relevance to LyX
 158
 159         The LyX homepage contains valuable information about LyX and the
 160         various LyX mailing lists, as well as links to mirrors and other
 161         LyX homepages around the world:
 162         http://www.lyx.org/
 163
 164         The LyX Wiki is the place where users can share information on
 165         setting up and using LyX.
 166         http://wiki.lyx.org/
 167
 168         The main LyX archive site:
 169         ftp://ftp.lyx.org/pub/lyx/
 170
 171         The LyX Development page has information about the development
 172         effort. LyX is under CVS control, so you can get the very
 173         latest sources from there at any time.
 174         http://www.devel.lyx.org/
 175         ftp://www.devel.lyx.org/pub/lyx/
 176
 177 How do I submit a bug report?
 178
 179         If possible, read the Introduction found under the Help menu in LyX.
 180         You'll find detailed info on submitting bug reports there.
 181
 182         If you can't do that, send details to the LyX Developers' mailing
 183         list, or use the LyX bug tracker at http://bugzilla.lyx.org/.
 184         Don't forget to mention which version you are having problems with!
 185
 186 How can I participate in the development of LyX?
 187
 188         Any help with the development of LyX is greatly appreciated ---
 189         after all, LyX wouldn't be what it is today without the help
 190         of volunteers. We need your help!
 191
 192         If you want to work on LyX, you should contact the developer's
 193         mailing list for discussion on how to do your stuff.  LyX is being
 194         cleaned up, and therefore it's important to follow some rules.
 195         Read about those rules in development/Code_rules/.
 196
 197         If you don't know C++, there are many other ways to
 198         contribute. Write documentation. Help to internationalize LyX
 199         by translating documentation or menus/error messages, or by
 200         writing a new keymap. Write a new textclass. Find bugs (but
 201         please read the list of known bugs first). Contribute money.
 202         Or just offer feature suggestions (but please read the online
 203         TODO list first).
 204
 205 Thank you for trying LyX. We appreciate your feedback in the mailing
 206 lists.
 207
 208 The LyX Team.