diff --git a/ChangeLog b/ChangeLog index 37d8449d78..dc085e1834 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2004-09-28 Jean-Marc Lasgouttes + + * README: update a bit + 2004-09-23 Bennett Helm * README.MacOSX: update again diff --git a/README b/README index cc5b3d1cc9..0373da0428 100644 --- a/README +++ b/README @@ -1,44 +1,3 @@ -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 - we would make only small stable changes between releases - and release more often. This lead to the 1.1.x series of LyX - releases during which the inhards of the program were 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 in which odd or - even numbering is not significant. Instead a number '1.x.y' - indicates stable release '1.x', fix level 'y'. Prereleases - are labeled with a "pre" 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 primarily 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? LyX is an advanced open-source "document processor". Unlike @@ -64,27 +23,57 @@ What is LyX not? What do I need to run LyX? - 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 + Either of : + * a Unix-like system (or Windows with cygwin, OS/2 with XFree) + with at least X11R5 + * Mac OS 10.2 of later + + A decent LaTeX2e installation (e.g. teTeX for unix) not older than 1995/12/01. + Python 1.5 or later to convert old LyX files Perl5.002 or later to import LaTeX files into LyX. +How does LyX version scheme work? + + LyX uses a continuous numbering scheme in which odd or + even numbering is not significant. Instead a number '1.x.y' + indicates stable release '1.x', fix level 'y'. Prereleases + are labeled with a "pre" suffix. Thus there are three possible + file names: + + lyx-1.3.0.tar.gz -- stable release + lyx-1.3.5.tar.gz -- second maintenance release of the + 1.3.0 stable release + lyx-1.4.0pre1.tar.gz -- potentially unstable test release + + The maintenance releases are designed primarily 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. + + If you get the source from cvs, the version string will look like + one of: + + 1.3.5cvs -- this is the stable branch on which maintenance + release 1.3.5 will eventually be tagged + 1.4.0cvs -- this is the main branch on which stable + release 1.4.0 will eventually be tagged + What's new? Read NEWS. -How do I install a binary distribution of LyX? +How do I install .tar.gz a binary distribution of LyX? Unpack it and run it. We recommend unpacking it in /usr/local, but it should work anywhere. In particular, you can try LyX in a temporary directory before installing permanently by typing "bin/lyx". - We recommend that you configure LyX system-wide by copying the - file share/lyx/lyxrc.example to share/lyx/lyxrc, and then - reading and modifying it. - You should read the notes regarding this particular build in the file README.bin. @@ -100,10 +89,12 @@ What do I need to compile LyX from the source distribution? gcc/g++, but some others work. As of LyX 1.3.0, you need at least gcc 2.95.X (or egcs 1.1.x). Another compiler known to work is compaq cxx 6.1. + Either: * The Xforms library, version 0.89.5 or newer. We recommend the LGPL version 1.0. * LibXpm, version 4.7 or newer. + Or: * The Qt library, version 2.x or 3.x. @@ -114,7 +105,7 @@ Okay, I've installed LyX. What now? Once you've installed it, and everything looks fine, go read the "Introduction" item under the Help menu. You should follow the instructions there, which tell you to read (or at least skim) - the Tutorial. After that, you should also read "Help/LaTeX + the Tutorial. After that, you should also read "Help>LaTeX configuration" which provides info on your LaTeX configuration as LyX sees it. You might be missing a package or two that you'd like to have. @@ -123,34 +114,30 @@ Okay, I've installed LyX. What now? Does LyX have support for non-English speakers/writers/readers? - Yes. LyX supports writing in many languages. + Yes. LyX supports writing in many languages, including + right-to-left languages like Arabic or Hebrew. There is a port + of LyX named CJK-LyX which adds support for Chinese, Korean + and Japanese (http://cellular.phys.pusan.ac.kr/cjk.html) Menus and error messages have been translated to the following languages (* means there are language-specific keyboard menu bindings as well): - Basque (eu) - Bulgarian (bg) - Catalan (ca) - Czech (cs) - Danish (da) - German (de) * - Spanish (es) - Finnish (fi) - French (fr) * - Hebrew (he) - Hungarian (hu) * + French (fr) Italian (it) - Dutch (nl) - Norwegian (no) - Polish (pl) - Portuguese (pt) * - Romanian (ro) + Danish (da) + Basque (eu) + Nynorsk (nn) + Spanish (es) + Finnish (fi) * + German (de) * Russian (ru) + Polish (pl) + Slovak (sk) Slovenian (sl) - Swedish (sv) * - Turkish (tr) - Walloon (wa) + Romanian (ro) + Norwegian (no) + Dutch (nl) Keymaps can ease typing in one or more of the following languages: @@ -177,6 +164,10 @@ Internet resources of relevance to LyX LyX homepages around the world: http://www.lyx.org/ + The LyX Wiki is the place where users can share information on + setting up and using LyX. + http://wiki.lyx.org/ + Main LyX archive site: ftp://ftp.lyx.org/pub/lyx/