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:
  29     * a Unix-like system (including Windows with cygwin)
  30     * Windows 2000 or newer
  31     * Mac OS 10.4 or newer
  32
  33     A decent LaTeX2e installation (e.g. TeX Live for Linux, MikTeX for
  34     Windows).
  35
  36     Python 2.4 or later to convert old LyX files and for helper scripts.
  37     Note 1: Python 2.4 or later is required due to the subprocess module.
  38     Note 2: Python 2.6 or later is recommended on Windows.
  39     Note 3: Python 3.0 or later is not supported.
  40
  41 How does the LyX version scheme work?
  42
  43     LyX uses a contiguous numbering scheme for versions, where a
  44     number "1.x.y" indicates a stable release '1.x', maintenance
  45     release 'y'.  In other words, LyX 1.5.0 was the first stable
  46     release in the 1.5-series of LyX. At the time of writing, the
  47     latest maintenance release in the 1.5-series was LyX 1.5.2
  48
  49     Please note that maintenance releases are designed primarily to
  50     fix bugs, and that the file format will _never_ change due to a
  51     maintenance release.
  52
  53     In addition to the stable releases and maintenance releases, some
  54     users may want to give a ''release candidate'' a try. This is a
  55     release that should be stable enough for daily work, but yet may
  56     be potentially unstable. If no major bugs are found, the release
  57     candiate is soon released as the first stable release in a a new
  58     series. To summarize, there are three possible types of file names
  59     that are of interest to normal users:
  60
  61        lyx-1.5.0.tar.gz     -- stable release, first in the 1.5-series
  62        lyx-1.5.5.tar.gz     -- fifth maintenance release of LyX 1.5
  63        lyx-1.5.0rc1.tar.gz  -- potentially unstable release candidate
  64
  65     Note that the goal is not parallel development as for the linux
  66     kernel --the team is too small to afford that-- but rather to
  67     include all the simple and safe bug fixes. This is so that the
  68     maintenance burden on us is not too high, and so that system
  69     administrators can install new releases without fear. Experience
  70     shows that these releases will contain a few new features, and
  71     that the bulk of the patches will be documentation updates.
  72
  73     If you get the source from Subversion, the version string will
  74     look like one of:
  75
  76        1.5.1svn     -- this is the stable branch on which maintenance
  77                release 1.5.1 will eventually be tagged.
  78        1.6.0svn     -- this is the main branch on which stable
  79                release 1.6.0 will eventually be tagged.
  80
  81 What's new?
  82
  83     Read NEWS.
  84
  85 How do I upgrade from an earlier LyX version?
  86
  87     Read the file UPGRADING for info on this subject.
  88
  89 What do I need to compile LyX from the source distribution?
  90
  91     * A good C++ compiler.  Development is being done mainly with
  92       gcc/g++, but some others work also. As of LyX 1.6.0, you need at
  93       least gcc 3.2.x.
  94
  95     * The Qt4 library, at least version 4.5.0. For all features
  96       newer versions (e.g. Qt 4.8) are recommended.
  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 Tools>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.
 116
 117     Menus and error messages have been translated to many languages.
 118     For the status of the different translations, see
 119     http://www.lyx.org/I18n
 120
 121     Keymaps can ease typing in many languages.
 122
 123 Internet resources of relevance to LyX
 124
 125     The LyX homepage contains valuable information about LyX and the
 126     various LyX mailing lists, as well as links to mirrors and other
 127     LyX homepages around the world:
 128         http://www.lyx.org/
 129
 130     The LyX Wiki is the place where users can share information on
 131     setting up and using LyX.
 132         http://wiki.lyx.org/
 133
 134     The main LyX archive site:
 135         ftp://ftp.lyx.org/pub/lyx/
 136
 137     The LyX Development page has information about the development
 138     effort. LyX is under Git version control, so you can get the very
 139     latest sources from there at any time.
 140         http://www.lyx.org/Development
 141
 142 How do I submit a bug report?
 143
 144     If possible, read the Introduction found under the Help menu in LyX.
 145     You'll find detailed info on submitting bug reports there.
 146
 147     If you can't do that, send details to the LyX Developers' mailing
 148     list, or use the LyX bug tracker at
 149     http://www.lyx.org/trac/wiki/BugTrackerHome.
 150     Don't forget to mention which version you are having problems with!
 151
 152 How can I participate in the development of LyX?
 153
 154     Any help with the development of LyX is greatly appreciated ---
 155     after all, LyX wouldn't be what it is today without the help
 156     of volunteers. We need your help!
 157
 158     If you want to work on LyX, you should contact the developer's
 159     mailing list for discussion on how to do your stuff.  LyX is being
 160     cleaned up, and therefore it's important to follow some rules.
 161     Read about those rules in development/Code_rules/.
 162
 163     If you don't know C++, there are many other ways to
 164     contribute. Write documentation. Help to internationalize LyX
 165     by translating documentation or menus/error messages, or by
 166     writing a new keymap. Write a new textclass. Find bugs (but
 167     please read the list of known bugs first). Contribute money.
 168     Or just offer feature suggestions (but please read the online
 169     TODO list first).
 170
 171 Thank you for trying LyX. We appreciate your feedback in the mailing
 172 lists.
 173
 174 The LyX Team.