add include

[lyx.git] / README

diff --git a/README b/README
index c5f6118dedf1d3b930ea7c4948a0fa4942f3decc..d71b2774843dec2b1ec6c1ad67de716a123d99c4 100644 (file)
--- a/README
+++ b/README
@@ -1,15 +1,43 @@
-This is a LyX development release
----------------------------------
+Preamble: LyX version scheme

 
 

-The LyX Team has adopted a new development model and
-tries to keep the development version stable as far
-as possible, but since the program is changing, the
-development version will be less stable than the
-stable releases.
+       In September of 1999 the LyX Team decided that we could no
+       longer successfully use the two strand development process
+       like the Linux kernel. We are in the process of switching to a
+       development model similar to that used by Fetchmail where we
+       will only make small stable changes between releases and
+       release more often. All future releases should be stable
+       although we are currently in a transition period where some
+       major changes have to be introduced and are likely to affect
+       the stability in the short term.

 
 

-So, don't use this development version on your production
-documents without testing everything in depth first.
+       These changes include: 

 
 

+        * Use of C++ Standard Library features such as the Standard
+          Template Library (STL), string and streams.  
+
+        * Establishing the foundations of GUI/system independence, 
+
+        * Rearrangement of the directory structure.
+
+       Once the transition is over the 1.1 series should be very
+       stable and we will then release 1.2.0. This new series will be
+       in a state of continual advancement. Note the word
+       "advancement" and not "development." Development will be
+       occurring in branches of CVS and once the feature/modification
+       has proved stable it will be merged into the main releases.
+
+       LyX now uses a continuous numbering scheme where odd or
+       even numbering is no longer significant. Prereleases are
+       labeled with a "pre" suffix and any fixes required between
+       stable releases have a "fix" suffix. Thus there are three
+       possible file names:
+
+          lyx-1.1.5.tar.gz       -- stable release
+          lyx-1.1.5fix2.tar.gz   -- bug fix of the 1.1.5 stable release.
+          lyx-1.1.5pre1.tar.gz   -- potentially unstable test release
+
+       The fix releases contain no new functionality; only fixes that
+       have already made their way into the cvs repository. 

 
 What is LyX?
 
 
 What is LyX?
 


@@ -41,6 +69,9 @@ What do I need to run LyX?
        A decent LaTeX2e installation (e.g. teTeX or NTeX) not older
           than 1995/12/01
        Optionally ghostscript and ghostview (or compatible)
        A decent LaTeX2e installation (e.g. teTeX or NTeX) not older
           than 1995/12/01
        Optionally ghostscript and ghostview (or compatible)

+               - note that ghostscript versions 6.22 through 6.52
+                 won't render inline figures in LyX. This is due to
+                 a ghostscript bug.

        Perl5.002 or later to import LaTeX files into LyX
 
 What's new?
        Perl5.002 or later to import LaTeX files into LyX
 
 What's new?


@@ -131,11 +162,13 @@ Does LyX have support for non-English speakers/writers/readers?
        Greek
        Hebrew
        Hungarian (Magyar)
        Greek
        Hebrew
        Hungarian (Magyar)

+       Latvian

        Polish
        Portugese
        Romanian
        Slovenian
        Turkish
        Polish
        Portugese
        Romanian
        Slovenian
        Turkish

+       Ukrainian

 
 Internet resources of relevance to LyX
 
 
 Internet resources of relevance to LyX
 


@@ -155,15 +188,12 @@ Internet resources of relevance to LyX
 
 How do I submit a bug report?
 
 
 How do I submit a bug report?
 

-       If possible, read the "Known Bugs" document found under the
-       Help menu.  You'll find detailed info on submitting bug reports
-       there.
-
-       You should also check the BUGS file in this directory.
+       If possible, read the Introduction found under the Help menu in LyX.
+       You'll find detailed info on submitting bug reports there.

 
        If you can't do that, send details to the LyX Developers mailing
 
        If you can't do that, send details to the LyX Developers mailing

-       list.  Don't forget to mention which version you are having
-       problems with!
+       list, or use the LyX bug tracker at http://lyxbugs.sf.net/.
+       Don't forget to mention which version you are having problems with!

 
 How can I participate in the development of LyX? 
 
 
 How can I participate in the development of LyX?