Fixes for the README file, from Joel Kulesza.

Fixes #11250.
This commit is contained in:
Richard Kimberly Heck 2018-08-28 15:28:39 -04:00
parent f0c18e1f41
commit 500729574f

36
README
View File

@ -12,7 +12,7 @@ What is LyX?
legendary TeX typesetting engine makes you look good. legendary TeX typesetting engine makes you look good.
On screen, LyX looks like any word processor; its printed output 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 looks like nothing else. Gone are the days of industrially bland
.docs, all looking similarly not-quite-right, yet coming out .docs, all looking similarly not-quite-right, yet coming out
unpredictably different on different printer drivers. Gone are the unpredictably different on different printer drivers. Gone are the
@ -26,7 +26,7 @@ What is LyX?
What do I need to run LyX? What do I need to run LyX?
Either: Either:
* a Unix-like system (including Windows with cygwin) * a Unix-like system (including Windows with Cygwin)
* Windows 2000 or newer * Windows 2000 or newer
* Mac OS 10.4 or newer * Mac OS 10.4 or newer
@ -39,10 +39,10 @@ What do I need to run LyX?
How does the LyX version scheme work? How does the LyX version scheme work?
LyX uses a contiguous numbering scheme for versions, where a LyX uses a contiguous numbering scheme for versions, where a
number "1.x.y" indicates a stable release '1.x', maintenance number "2.x.y" indicates a stable release '2.x', maintenance
release 'y'. In other words, LyX 1.5.0 was the first stable release 'y'. In other words, LyX 2.2.0 was the first stable
release in the 1.5-series of LyX. At the time of writing, the release in the 2.2-series of LyX. At the time of writing, the
latest maintenance release in the 1.5-series was LyX 1.5.2 latest maintenance release in the 2.2-series is LyX 2.2.4.
Please note that maintenance releases are designed primarily to Please note that maintenance releases are designed primarily to
fix bugs, and that the file format will _never_ change due to a fix bugs, and that the file format will _never_ change due to a
@ -52,16 +52,16 @@ How does the LyX version scheme work?
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 release that should be stable enough for daily work, but yet may
be potentially unstable. If no major bugs are found, the release 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 series. To summarize, there are three possible types of file names
that are of interest to normal users: that are of interest to normal users:
lyx-1.5.0.tar.gz -- stable release, first in the 1.5-series lyx-2.3.0.tar.gz -- stable release, first in the 2.3-series
lyx-1.5.5.tar.gz -- fifth maintenance release of LyX 1.5 lyx-2.2.4.tar.gz -- fourth maintenance release of LyX 2.2
lyx-1.5.0rc1.tar.gz -- potentially unstable release candidate lyx-2.4.0rc1.tar.gz -- potentially unstable release candidate
Note that the goal is not parallel development as for the linux Note that the goal is not parallel development as for the Linux
kernel --the team is too small to afford that-- but rather to 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 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 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
@ -71,10 +71,10 @@ How does the LyX version scheme work?
If you get the source from Git, the version string will look like If you get the source from Git, the version string will look like
one of: one of:
2.0.6dev -- this is the stable branch on which maintenance 2.3.1dev -- this is the stable branch on which maintenance
release 2.0.6 will eventually be tagged. release 2.3.1 will eventually be tagged.
2.1.0dev -- this is the main branch on which stable 2.4.0dev -- this is the main branch on which stable
release 2.1.0 will eventually be tagged. release 2.4.0 will eventually be tagged.
What's new? What's new?
@ -90,7 +90,7 @@ What do I need to compile LyX from the source distribution?
gcc/g++, but some others work also. As of LyX 2.3.0, you need gcc/g++, but some others work also. As of LyX 2.3.0, you need
at least gcc 4.6.x. at least gcc 4.6.x.
* The Qt4 library, at least version 4.8.0. For all features * The Qt library, at least version 4.8.0. For all features
newer versions (e.g. Qt 5.6) are recommended. newer versions (e.g. Qt 5.6) are recommended.
Read the file "INSTALL" for more information on compiling. Read the file "INSTALL" for more information on compiling.
@ -144,7 +144,7 @@ How do I submit a bug report?
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, or use the LyX bug tracker at list, or use the LyX bug tracker at
http://www.lyx.org/trac/wiki/BugTrackerHome http://www.lyx.org/trac/wiki/BugTrackerHome .
Don't forget to mention which version you are having problems with! 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?