README

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