X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=README;h=6bf665c2988f25cb142eb602339bd6b363c169a0;hb=0453939fbe12fa9444307781041d3d62f0f522af;hp=f42da049d508d57bd1cb1d8e84419e73b34deca9;hpb=cad4d9a025c998907172396a8ccae8761893914e;p=lyx.git diff --git a/README b/README index f42da049d5..6bf665c298 100644 --- 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? @@ -41,11 +69,14 @@ 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) + - note that ghostscript versions 6.22 through 6.50 + 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? - Read WHATSNEW. + Read NEWS. How do I install a binary distribution of LyX? @@ -71,7 +102,7 @@ What do I need to compile LyX from the source distribution? 1. A good c++ compiler. Development is being done mainly on gcc/g++, but many others work. - 2. The Xforms library version 0.81, 0.86 or 0.88. + 2. The Xforms library version 0.88 (recommended) or 0.89. 3. LibXpm version 4.7 (or newer). Read the file "INSTALL" for more information on compiling. @@ -100,6 +131,7 @@ Does LyX have support for non-English speakers/writers/readers? languages (* means there are language-specific keyboard menu bindings as well): + Basque (eu) Catalan (ca) Czech (cs) Danish (da) @@ -107,12 +139,14 @@ Does LyX have support for non-English speakers/writers/readers? Spanish (es) Finnish (fi) French (fr) * + Hebrew (he) Hungarian (hu) * Italian (it) Dutch (nl) Norwegian (no) Polish (pl) Portuguese (pt) * + Romanian (ro) Russian (ru) Slovenian (sl) Swedish (sv) * @@ -121,16 +155,20 @@ Does LyX have support for non-English speakers/writers/readers? Keymaps can ease typing in one or more of the following languages: + Arabic Czech French, Swiss French German, Swiss German Greek + Hebrew Hungarian (Magyar) + Latvian Polish Portugese Romanian Slovenian Turkish + Ukrainian Internet resources of relevance to LyX @@ -148,61 +186,16 @@ Internet resources of relevance to LyX http://www.devel.lyx.org/ ftp://www.devel.lyx.org/pub/lyx/ -What is the numbering scheme for releases? Is it like the Linux kernel? - - Yes, it's like the Linux kernel since LyX version 0.8: - - 0.10.x, 0.12.x, 1.0.x ... are stable, public releases - 0.11.x, 0.13.x, 1.1.x ... are developer releases - - Of course you may also use the developer releases, but only - at your own risk. This is definitely higher than your risk when - using the public releases, even if this is your own risk, too. - 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 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! -How do I prepare a binary distribution for the use of others? - - 1) Compile LyX with the right compiler switches for your - architecture. In particular you might want to ensure that libraries - like xforms and xpm are statically linked. To this end, you - can use a command like - - make LYX_LIBS='/foo/libforms.a /bar/libXpm.a' - - Moreover, make sure you use the --without-latex-config switch - of configure, since others might not be interested by your - configuration :-) - - 2) Create a file README.bin describing your distribution and - referring to *you* if problems arise. As a model, you can use the - file development/tools/README.bin.example which was originally - written for Linux by David L. Johnson. Do *not* use directly - the file in the distribution, since it refers to Linux and - points to David L. Johnson for help. However, it can be a good - starting point. Note that removing the file completely is - better than not editing it at all. - - 3) Type `make bindist'. This will create a file - lyx-1.xx.yy-bin.tar.gz. Rename it to reflect you architecture - and the peculiarities of your build (e.g. static vs. dynamic). - - 4) Check that everything is correct by unpacking the distribution - in some private place and running it. In particular, check the - output of `ldd lyx' to know which libraries are really needed. - - 5) Upload your binary file to ftp.lyx.org:/pub/lyx/uploads. - How can I participate in the development of LyX? Any help with the development of LyX is greatly appreciated--