README

   1 What is LyX?
   2
   3     LyX is a document processor that encourages an approach to
   4     writing based on the structure of your documents, not their
   5     appearance. It is released under a Free Software / Open Source
   6     license.
   7
   8     LyX is for people that write and want their writing to look great,
   9     right out of the box. No more endless tinkering with formatting
  10     details, 'finger painting' font attributes or futzing around with
  11     page boundaries. You just write. In the background, Prof. Knuth's
  12     legendary TeX typesetting engine makes you look good.
  13
  14     On screen, LyX looks like any word processor; its printed output
  15     -- or richly cross-referenced PDF, just as readily produced --
  16     looks like nothing else. Gone are the days of industrially bland
  17     .docs, all looking similarly not-quite-right, yet coming out
  18     unpredictably different on different printer drivers. Gone are the
  19     crashes 'eating' your dissertation the evening before going to
  20     press.
  21
  22     LyX is stable and fully featured. It is a multi-platform, fully
  23     internationalized application running natively on Unix/Linux and
  24     the Macintosh and modern Windows platforms.
  25
  26 What do I need to run LyX?
  27
  28     Either of :
  29     * a Unix-like system (including Windows with cygwin)
  30     * Windows 2000 or newer
  31     * Mac OS 10.2 or newer
  32
  33     A decent LaTeX2e installation (e.g. teTeX for unix) not older
  34        than 1995/12/01.
  35     Python 2.3 or later to convert old LyX files and for helper scripts
  36     (note that you need at least Python 2.3.4 for exporting LyX files
  37     to a pre-unicode format, as previous versions are affected by a bug
  38     about the normalization of unicode strings)
  39
  40 How does the LyX version scheme work?
  41
  42     LyX uses a contiguous numbering scheme for versions, where a
  43     number "1.x.y" indicates a stable release '1.x', maintenance
  44     release 'y'.  In other words, LyX 1.5.0 was the first stable
  45     release in the 1.5-series of LyX. At the time of writing, the
  46     latest maintenance release in the 1.5-series was LyX 1.5.2
  47
  48     Please note that maintenance releases are designed primarily to
  49     fix bugs, and that the file format will _never_ change due to a
  50     maintenance release.
  51
  52     In addition to the stable releases and maintenance releases, some
  53     users may want to give a ''release candidate'' a try. This is a
  54     release that should be stable enough for daily work, but yet may
  55     be potentially unstable. If no major bugs are found, the release
  56     candiate is soon released as the first stable release in a a new
  57     series. To summarize, there are three possible types of file names
  58     that are of interest to normal users:
  59
  60        lyx-1.5.0.tar.gz     -- stable release, first in the 1.5-series
  61        lyx-1.5.5.tar.gz     -- fifth maintenance release of LyX 1.5
  62        lyx-1.5.0rc1.tar.gz  -- potentially unstable release candidate
  63
  64     Note that the goal is not parallel development as for the linux
  65     kernel --the team is too small to afford that-- but rather to
  66     include all the simple and safe bug fixes. This is so that the
  67     maintenance burden on us is not too high, and so that system
  68     administrators can install new releases without fear.  Experience
  69     shows that these releases will contain a few new features, and
  70     that the bulk of the patches will be documentation updates.
  71
  72     If you get the source from Subversion, the version string will
  73     look like one of:
  74
  75        1.5.1svn     -- this is the stable branch on which maintenance
  76                release 1.5.1 will eventually be tagged.
  77        1.6.0svn     -- this is the main branch on which stable
  78                release 1.6.0 will eventually be tagged.
  79
  80 What's new?
  81
  82     Read NEWS.
  83
  84 How do I upgrade from an earlier LyX version?
  85
  86     Read the file UPGRADING for info on this subject.
  87
  88 What do I need to compile LyX from the source distribution?
  89
  90     * A good C++ compiler.  Development is being done mainly with
  91       gcc/g++, but some others work also. As of LyX 1.6.0, you need at
  92       least gcc 3.2.x.
  93
  94     * The Qt4 library, version 4.2.0 or newer.
  95
  96     Read the file "INSTALL" for more information on compiling.
  97
  98 Okay, I've installed LyX. What now?
  99
 100     Once you've installed it, and everything looks fine, go read
 101     the "Introduction" item under the Help menu.  You should follow
 102     the instructions there, which tell you to read (or at least skim)
 103     the Tutorial. After that, you should also read "Help>LaTeX
 104     configuration" which provides info on your LaTeX configuration
 105     as LyX sees it.  You might be missing a package or two that you'd
 106     like to have.
 107
 108     User-level configuration is possible via the Tools>Preferences menu.
 109
 110 Does LyX have support for non-English speakers/writers/readers?
 111
 112     Yes. LyX supports writing in many languages, including
 113     right-to-left languages like Arabic or Hebrew. There is a port
 114     of LyX named CJK-LyX which adds support for Chinese, Korean
 115     and Japanese (http://cellular.phys.pusan.ac.kr/cjk.html)
 116     [This support is being merged in lyx-1.5]
 117
 118     Menus and error messages have been translated to 17 languages.
 119     For the status of the different translations, see
 120     http://www.lyx.org/devel/i18n.php
 121
 122     Keymaps can ease typing in many languages.
 123
 124 Internet resources of relevance to LyX
 125
 126     The LyX homepage contains valuable information about LyX and the
 127     various LyX mailing lists, as well as links to mirrors and other
 128     LyX homepages around the world:
 129         http://www.lyx.org/
 130
 131     The LyX Wiki is the place where users can share information on
 132     setting up and using LyX.
 133         http://wiki.lyx.org/
 134
 135     The main LyX archive site:
 136         ftp://ftp.lyx.org/pub/lyx/
 137
 138     The LyX Development page has information about the development
 139     effort. LyX is under Subversion control, so you can get the very
 140     latest sources from there at any time.
 141         http://www.lyx.org/devel
 142         ftp://ftp.devel.lyx.org/pub/lyx/
 143
 144 How do I submit a bug report?
 145
 146     If possible, read the Introduction found under the Help menu in LyX.
 147     You'll find detailed info on submitting bug reports there.
 148
 149     If you can't do that, send details to the LyX Developers' mailing
 150     list, or use the LyX bug tracker at http://bugzilla.lyx.org/.
 151     Don't forget to mention which version you are having problems with!
 152
 153 How can I participate in the development of LyX?
 154
 155     Any help with the development of LyX is greatly appreciated ---
 156     after all, LyX wouldn't be what it is today without the help
 157     of volunteers. We need your help!
 158
 159     If you want to work on LyX, you should contact the developer's
 160     mailing list for discussion on how to do your stuff.  LyX is being
 161     cleaned up, and therefore it's important to follow some rules.
 162     Read about those rules in development/Code_rules/.
 163
 164     If you don't know C++, there are many other ways to
 165     contribute. Write documentation. Help to internationalize LyX
 166     by translating documentation or menus/error messages, or by
 167     writing a new keymap. Write a new textclass. Find bugs (but
 168     please read the list of known bugs first). Contribute money.
 169     Or just offer feature suggestions (but please read the online
 170     TODO list first).
 171
 172 Thank you for trying LyX. We appreciate your feedback in the mailing
 173 lists.
 174
 175 The LyX Team.