X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=README;h=dfc57d323213ec4d23ceebe17afb613809c5b8d8;hb=231b36d95011f99993684add6e0cdd6012ec13d4;hp=56c241191afd6389c8f375399338005a24ce16de;hpb=54d2810b013501bed18e8ce461f48e8ed7ff247f;p=lyx.git diff --git a/README b/README index 56c241191a..dfc57d3232 100644 --- a/README +++ b/README @@ -12,7 +12,7 @@ What is LyX? legendary TeX typesetting engine makes you look good. On screen, LyX looks like any word processor; its printed output - -- or richly cross-referenced PDF, just as readily produced -- + --- or richly cross-referenced PDF, just as readily produced --- looks like nothing else. Gone are the days of industrially bland .docs, all looking similarly not-quite-right, yet coming out unpredictably different on different printer drivers. Gone are the @@ -25,54 +25,56 @@ What is LyX? What do I need to run LyX? - Either of : - * a Unix-like system (including Windows with cygwin) + Either: + * a Unix-like system (including Windows with Cygwin) * Windows 2000 or newer - * Mac OS 10.2 or newer + * Mac OS 10.4 or newer - A decent LaTeX2e installation (e.g. teTeX for unix) not older - than 1995/12/01. - Python 2.3 or later to convert old LyX files and for helper scripts + A decent LaTeX2e installation (e.g. TeX Live for Linux, MikTeX for + Windows). + + Python (2.7 or 3.5 and newer) to convert old LyX files and for + helper scripts. How does the LyX version scheme work? LyX uses a contiguous numbering scheme for versions, where a - number "1.x.y" indicates a stable release '1.x', maintenance - release 'y'. In other words, LyX 1.4.0 was the first stable - release in the 1.4-series of LyX. At the time of writing, the - latest maintenance release in the 1.4-series was LyX 1.4.4. + number "2.x.y" indicates a stable release '2.x', maintenance + release 'y'. In other words, LyX 2.3.0 was the first stable + release in the 2.3-series of LyX. At the time of writing, the + latest maintenance release in the 2.3-series is LyX 2.3.4. Please note that maintenance releases are designed primarily to fix bugs, and that the file format will _never_ change due to a maintenance release. In addition to the stable releases and maintenance releases, some - users may want to give a ''release candidate'' a try. This is a + users may want to give a ``release candidate'' a try. This is a release that should be stable enough for daily work, but yet may be potentially unstable. If no major bugs are found, the release - candiate is soon released as the first stable release in a a new + candidate is soon released as the first stable release in a new series. To summarize, there are three possible types of file names that are of interest to normal users: - lyx-1.5.0.tar.gz -- stable release, first in the 1.5-series - lyx-1.5.5.tar.gz -- fifth maintenance release of LyX 1.5 - lyx-1.5.0rc1.tar.gz -- potentially unstable release candidate + lyx-2.3.0.tar.gz -- stable release, first in the 2.3-series + lyx-2.2.4.tar.gz -- fourth maintenance release of LyX 2.2 + lyx-2.4.0rc1.tar.gz -- potentially unstable release candidate - Note that the goal is not parallel development as for the linux - kernel --the team is too small to afford that-- but rather to + Note that the goal is not parallel development as for the Linux + kernel --- the team is too small to afford that --- but rather to include all the simple and safe bug fixes. This is so that the maintenance burden on us is not too high, and so that system - administrators can install new releases without fear. Experience + administrators can install new releases without fear. 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 Subversion, the version string will - look like one of: + If you get the source from Git, the version string will look like + one of: - 1.5.1svn -- this is the stable branch on which maintenance - release 1.5.1 will eventually be tagged. - 1.6.0svn -- this is the main branch on which stable - release 1.6.0 will eventually be tagged. + 2.3.1dev -- this is the stable branch on which maintenance + release 2.3.1 will eventually be tagged. + 2.4.0dev -- this is the main branch on which stable + release 2.4.0 will eventually be tagged. What's new? @@ -84,11 +86,13 @@ How do I upgrade from an earlier LyX version? What do I need to compile LyX from the source distribution? - * A good C++ compiler. Development is being done mainly with - gcc/g++, but some others work also. As of LyX 1.5.0, you need at - least gcc 3.2.x. + * A C++11 compiler. Development is being done mainly with gcc/g++, + but clang and MSVC are known to work too. As of LyX 2.4.0, you + need at least gcc 4.7. - * The Qt4 library, version 4.1.1 or newer. + * The Qt library, at least version 5.2 (5.6 recommended). It is + still possible to compile with Qt 4.8, but this is not + recommended. Read the file "INSTALL" for more information on compiling. @@ -107,14 +111,11 @@ Okay, I've installed LyX. What now? Does LyX have support for non-English speakers/writers/readers? 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) - [This support is being merged in lyx-1.5] + right-to-left languages like Arabic or Hebrew. - Menus and error messages have been translated to 17 languages. + Menus and error messages have been translated to many languages. For the status of the different translations, see - http://www.lyx.org/devel/i18n.php + http://www.lyx.org/I18n Keymaps can ease typing in many languages. @@ -133,10 +134,9 @@ Internet resources of relevance to LyX ftp://ftp.lyx.org/pub/lyx/ The LyX Development page has information about the development - effort. LyX is under Subversion control, so you can get the very + effort. LyX is under Git version control, so you can get the very latest sources from there at any time. - http://www.lyx.org/devel - ftp://ftp.devel.lyx.org/pub/lyx/ + http://www.lyx.org/Development How do I submit a bug report? @@ -144,7 +144,8 @@ How do I submit a bug report? You'll find detailed info on submitting bug reports there. If you can't do that, send details to the LyX Developers' mailing - list, or use the LyX bug tracker at http://bugzilla.lyx.org/. + list, or use the LyX bug tracker at + http://www.lyx.org/trac/wiki/BugTrackerHome . Don't forget to mention which version you are having problems with! How can I participate in the development of LyX?