README

   1 This is a LyX development release
   2 ---------------------------------
   3
   4 The LyX Team has adopted a new development model and
   5 tries to keep the development version stable as far
   6 as possible, but since the program is changing, the
   7 development version will be less stable than the
   8 stable releases.
   9
  10 So, don't use this development version on your production
  11 documents without testing everything in depth first.
  12
  13
  14 What is LyX?
  15
  16         LyX is an advanced open-source "document processor". Unlike
  17         standard word processors, LyX encourages writing based on the
  18         structure of your documents, not their appearance. It lets you
  19         concentrate on writing, leaving details of visual layout to the
  20         software.
  21
  22         You can read more about this concept in the documentation,
  23         which you'll find under the Help menu.  If you plan to use LyX,
  24         you really should read about it to be able to make the best of
  25         it.
  26
  27 What is LyX not?
  28
  29         LyX is not just another word processor that claims to be a
  30         Desktop Publishing program.  It's a more modern way of
  31         creating documents that look much nicer, but without wasting
  32         time with layout-fiddling.  For these reasons you might need
  33         little time to get used to the differences.
  34         If you are looking for a free Desktop Publishing program for
  35         Unix, you will be disappointed.
  36
  37 What do I need to run LyX?
  38
  39         A Unix-like system or OS/2 with XFree
  40         At least X11 Release 5
  41         A decent LaTeX2e installation (e.g. teTeX or NTeX) not older
  42            than 1995/12/01
  43         Optionally ghostscript and ghostview (or compatible)
  44         Perl5.002 or later to import LaTeX files into LyX
  45
  46 What's new?
  47
  48         Read NEWS.
  49
  50 How do I install a binary distribution of LyX?
  51
  52         Unpack it and run it.  We recommend unpacking it in /usr/local,
  53         but it should work anywhere.  In particular, you can try LyX
  54         in a temporary directory before installing permanently by
  55         typing "bin/lyx".
  56
  57         We recommend that you configure LyX system-wide by copying the
  58         file share/lyx/lyxrc.example to share/lyx/lyxrc, and then
  59         reading and modifying it.
  60
  61         You should read the notes regarding this particular build in
  62         the file README.bin.
  63
  64 How do I upgrade from an earlier LyX version?
  65
  66         Read the file UPGRADING for info on this subject.
  67         If you are upgrading from version 0.12.0 or later, you don't
  68         need to do anything special.
  69
  70 What do I need to compile LyX from the source distribution?
  71
  72         1. A good c++ compiler.  Development is being done mainly on
  73            gcc/g++, but many others work.
  74         2. The Xforms library version 0.88 (recommended) or 0.89.
  75         3. LibXpm version 4.7 (or newer).
  76
  77         Read the file "INSTALL" for more information on compiling.
  78
  79 Okay, I've installed LyX. What now?
  80
  81         Once you've installed it, and everything looks fine, go read
  82         the "Introduction" item under the Help menu.  You should follow
  83         the instructions there, which tell you to read (or at least skim)
  84         the Tutorial. After that, you should also read "Help/LaTeX
  85         configuration" which provides info on your LaTeX configuration
  86         as LyX sees it.  You might be missing a package or two that you'd
  87         like to have.
  88
  89         User-level configuration is possible with a file "~/.lyx/lyxrc".
  90         You can use the system-wide lyxrc file (which should be somewhere
  91         like /usr/local/share/lyx/lyxrc) as a template for your personal
  92         lyxrc file.  Remember that a personal configuration file will be
  93         used instead of, not in addition to, any system-wide file.
  94
  95 Does LyX have support for non-English speakers/writers/readers?
  96
  97         Yes. LyX supports writing in many languages.
  98
  99         Menus and error messages have been translated to the following
 100         languages (* means there are language-specific keyboard menu
 101         bindings as well):
 102
 103         Basque      (eu)
 104         Catalan     (ca)
 105         Czech       (cs)
 106         Danish      (da)
 107         German      (de)    *
 108         Spanish     (es)
 109         Finnish     (fi)
 110         French      (fr)    *
 111         Hebrew      (he)
 112         Hungarian   (hu)    *
 113         Italian     (it)
 114         Dutch       (nl)
 115         Norwegian   (no)
 116         Polish      (pl)
 117         Portuguese  (pt)    *
 118         Romanian    (ro)
 119         Russian     (ru)
 120         Slovenian   (sl)
 121         Swedish     (sv)    *
 122         Turkish     (tr)
 123         Walloon     (wa)
 124
 125         Keymaps can ease typing in one or more of the following languages:
 126
 127         Arabic
 128         Czech
 129         French, Swiss French
 130         German, Swiss German
 131         Greek
 132         Hebrew
 133         Hungarian (Magyar)
 134         Polish
 135         Portugese
 136         Romanian
 137         Slovenian
 138         Turkish
 139
 140 Internet resources of relevance to LyX
 141
 142         The LyX homepage contains valuable information about LyX and the
 143         various LyX mailing lists, as well as links to mirrors and other
 144         LyX homepages around the world:
 145         http://www.lyx.org/
 146
 147         Main LyX archive site:
 148         ftp://ftp.lyx.org/pub/lyx/
 149
 150         The LyX Development page has information about the development
 151         effort. LyX is now under CVS control, so you can get the very
 152         latest sources from there at any time.
 153         http://www.devel.lyx.org/
 154         ftp://www.devel.lyx.org/pub/lyx/
 155
 156 How do I submit a bug report?
 157
 158         If possible, read the "Known Bugs" document found under the
 159         Help menu.  You'll find detailed info on submitting bug reports
 160         there.
 161
 162         You should also check the BUGS file in this directory.
 163
 164         If you can't do that, send details to the LyX Developers mailing
 165         list.  Don't forget to mention which version you are having
 166         problems with!
 167
 168 How can I participate in the development of LyX?
 169
 170         Any help with the development of LyX is greatly appreciated--
 171         after all LyX wouldn't be what it is today without the help
 172         of volunteers. We need your help!
 173
 174         If you want to work on LyX, you should contact the developer's
 175         mailing list for discussion on how to do your stuff.  LyX is being
 176         cleaned up, and therefore it's important to follow some rules.
 177         Read about those rules in development/Code_rules/.
 178
 179         If you don't know C++, there are many other ways to contribute.
 180         Write documentation. Help to internationalize LyX by translating
 181         documentation or menus/error messages, or by writing a new keymap.
 182         Write a new textclass.  Work on reLyX (Perl). Find bugs (but please
 183         read the list of known bugs first). Contribute money. Or just offer
 184         feature suggestions (but please read the online TODO list first).
 185
 186 Thank you for trying LyX, and we appreciate your feedback in the mailing
 187 lists.
 188
 189 The LyX Team.