X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=README;h=c7dd89c7359541322ee6b76c0bad5417ae661dd8;hb=dab43e77955e5b21fa556f53143d42e09e439f40;hp=64c8144387b3cf01548bea865f9aa2bb5a9ecad2;hpb=2f65de9f7d488d0fd88e0b2f165516c8702c5dc1;p=lyx.git diff --git a/README b/README index 64c8144387..c7dd89c735 100644 --- a/README +++ b/README @@ -1,15 +1,43 @@ -This is a LyX development release ---------------------------------- - -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. - -So, don't use this development version on your production -documents without testing everything in depth first. - +Preamble: LyX version scheme + + In September of 1999 the LyX Team decided that we could no + longer successfully use the two strand development process + like the Linux kernel. The idea was to to switch to a + development model similar to that used by Fetchmail where only + we would will only make small stable changes between releases + and release more often. This lead to the 1.1.x series of LyX + releases where the inhards of the program have been rewritten + to make use of the C++ Standard Library features, establish + the foundations of GUI/system independence, and generally + clean up the data structures used in the core of LyX. + + As of April 2002, this transition phase is completed and we + feel it is time to switch to (yet) another version scheme. + 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 still uses a continuous numbering scheme where odd or + even numbering is not 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.2.0.tar.gz -- stable release + lyx-1.2.2.tar.gz -- second maintenance release of the + 1.2.0 stable release + lyx-1.2.0pre1.tar.gz -- potentially unstable test release + + The maintenance releases are designed mainly to fix bugs. The + goal here is not to have parallel development as for the linux + kernel (the team is too small to afford that), but rather to + include all the simple (so that the maintenance burden on us + is not too high) and safe (so that system administrators can + install them without fear) bug fixes. Experience shows that + these releases will contain a few new features, and that the + bulk of the patches will be documentation updates. What is LyX? @@ -36,11 +64,10 @@ What is LyX not? What do I need to run LyX? - A Unix-like system or OS/2 with XFree + A Unix-like system or Windows with cygwin, OS/2 with XFree At least X11 Release 5 A decent LaTeX2e installation (e.g. teTeX or NTeX) not older than 1995/12/01 - Optionally ghostscript and ghostview (or compatible) Perl5.002 or later to import LaTeX files into LyX What's new? @@ -70,8 +97,10 @@ How do I upgrade from an earlier LyX version? 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. + gcc/g++, but some others work. As of LyX 1.2.0, you need at + least gcc 2.95.X (or egcs 1.1.x). Another compiler known to + work is compaq cxx 6.1. + 2. The Xforms library version 0.89.6 (recommended) or 0.88.1. 3. LibXpm version 4.7 (or newer). Read the file "INSTALL" for more information on compiling. @@ -86,11 +115,7 @@ Okay, I've installed LyX. What now? as LyX sees it. You might be missing a package or two that you'd like to have. - User-level configuration is possible with a file "~/.lyx/lyxrc". - You can use the system-wide lyxrc file (which should be somewhere - like /usr/local/share/lyx/lyxrc) as a template for your personal - lyxrc file. Remember that a personal configuration file will be - used instead of, not in addition to, any system-wide file. + User-level configuration is possible via the Edit>Preferences menu. Does LyX have support for non-English speakers/writers/readers? @@ -100,6 +125,8 @@ Does LyX have support for non-English speakers/writers/readers? languages (* means there are language-specific keyboard menu bindings as well): + Basque (eu) + Bulgarian (bg) Catalan (ca) Czech (cs) Danish (da) @@ -107,12 +134,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 +150,21 @@ Does LyX have support for non-English speakers/writers/readers? Keymaps can ease typing in one or more of the following languages: + Arabic + Bulgarian 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,60 +182,14 @@ 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 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 - 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. + list, or use the LyX bug tracker at http://bugzilla.lyx.org/. + Don't forget to mention which version you are having problems with! How can I participate in the development of LyX?