home *** CD-ROM | disk | FTP | other *** search
/ Dream 52 / Amiga_Dream_52.iso / Linux / Divers / lyx-0.13.2.tar.gz / lyx-0.13.2.tar / lyx-0.13.2 / README < prev    next >
Text File  |  1998-04-23  |  11KB  |  324 lines
  1. This is a LyX 0.13.x release
  2. --------------------------
  3.  
  4. *********************************************************************
  5. THIS VERSION OF LYX IS HIGHLY EXPERIMENTAL. PLEASE USE LYX 0.12.x FOR
  6. REAL WORK !!!
  7. *********************************************************************
  8.  
  9. What is LyX?
  10.  
  11.     LyX is a modern approach of writing documents with a computer
  12.     which breaks with the tradition of the obsolete typewriter
  13.     concept.  It is designed for people who want a professional
  14.     output with a minimum of time effort, without becoming specia-
  15.     lists in typesetting.  Compared to common word processors LyX
  16.     will increase the productivity a lot, since most of the type-
  17.     setting will be done by the computer, not the author.  With LyX
  18.     the author can concentrate on the contents of his writing,
  19.     since the computer will take care of the look.
  20.  
  21.     You can read more about this concept in the documentation,
  22.     which you'll find under the Help menu.  If you plan to use LyX, 
  23.     you actually should read about it to be able to make the best of 
  24.     it.
  25.  
  26. What is LyX not?
  27.  
  28.     LyX is not just another word processor that claims to be a
  29.     Desktop Publishing program.  It's a more modern way of
  30.     creating documents that look much nicer, but without wasting 
  31.     time with layout-fiddling.  For these reasons you might need 
  32.     little time to get used to the differences.
  33.     If you are looking for a free Desktop Publishing program for
  34.     Unix, you will be disappointed.
  35.  
  36. What do I need to run LyX?
  37.  
  38.     A Unix-like system or OS/2 with XFree
  39.     At least X11 Release 5
  40.     A decent LaTeX2e installation (e.g. teTeX or NTeX)
  41.     Optionally ghostscript and ghostview (or compatible)
  42.  
  43. What's new?
  44.  
  45.     Read WHATSNEW.
  46.  
  47. How do I install a binary distribution of LyX?
  48.  
  49.     Unpack it and run it.  We recommend to unpack it in /usr/local,
  50.     but it should work anywhere.  In particular, you can try LyX
  51.     in a temporary directory before installing permanently by
  52.     typing "bin/lyx".
  53.  
  54.     We recommend that you configure LyX system wide by reading and
  55.     modifying the "lib/lyxrc" file, usually found as the file
  56.     "/usr/local/share/lyx/lyxrc".
  57.  
  58.     User-level configuration is possible with a file "~/.lyx/lyxrc".
  59.     You can use the system wide file "lib/lyxrc" as a template for your
  60.     personal lyxrc file.  Remember that a personal configuration file
  61.     will be used instead of any system wide file.
  62.  
  63.     If this is a binary release, you should read the notes regarding
  64.     this particular build in README.bin.
  65.  
  66. How do I upgrade from LyX version 0.8.x or 0.10.x?
  67.  
  68.     Read the file UPGRADING for info on this subject. 
  69.  
  70. What do I need to compile LyX?
  71.  
  72.     This section only applies for people using the source distribution.
  73.  
  74.     1. A good c++ compiler.  Development is being done mainly on
  75.        gcc/g++, but many others work.
  76.     2. The Xforms library version 0.88. It is available from
  77.             http://bloch.phys.uwm.edu/xforms
  78.             ftp://einstein.phys.uwm.edu/pub/xforms/
  79.        It is available (free) only in binary format, source code is
  80.        not available.  If it is not available for your machine,
  81.        contact the Xforms developers to request a version for
  82.        your system.
  83.     3. LibXpm version 4.7 (or newer).  Older libXpm versions are
  84.        incompatible with the current Xforms library. You can find
  85.        libXpm at this link:
  86.         http://www.funet.fi/pub/Linux/sunsite/X11/libs/!INDEX.html
  87.  
  88.     Read the file "INSTALL" for more information on compiling.
  89.  
  90.     If this is a brand new development release and you have trouble
  91.     compiling, chances are that a fix has been discussed on the
  92.     developer's mailing list. Check the mailing list archives.
  93.  
  94. Okay, I've installed LyX. What now?
  95.  
  96.     Once you've installed it, and everything looks fine, go read
  97.     the "Introduction" item under the Help menu.  After that, you 
  98.     should also read "Help/LaTeX configuration" which provides info 
  99.     on your LaTeX configuration as LyX sees it.  You might miss a package
  100.     or two that you'd like to have.
  101.  
  102. There is a mailing list intended for users:
  103.  
  104.     Use this list if you have questions on how to get LyX working,
  105.     how to use LyX and other question related to usage. You can
  106.     also check the FAQ, see below.
  107.  
  108.     To subscribe send mail to 
  109.  
  110.         lyx-users-request@fiwi02.wiwi.uni-tuebingen.de
  111.  
  112.     with "subscribe" as the subject.
  113.     
  114.     To contribute to the mailing list, mail to
  115.  
  116.         lyx-users@fiwi02.wiwi.uni-tuebingen.de
  117.  
  118.     Please send unsubscription messages to lyx-users-request only!
  119.  
  120.     This mailing list is mirrored and archived on the Web at
  121.  
  122.         http://bioclox.bot.biologie.uni-tuebingen.de/
  123.                 mailing-archive/lyxlist/maillist.html
  124.  
  125.     courtesy of Dirk Engelmann.
  126.  
  127. There is also a mailing list for developers available:
  128.  
  129.     This list is intended only for the discussion of subjects
  130.     relevant to the implementation, planning, hacking and
  131.     improvement of LyX.
  132.  
  133.     To subscribe send mail to 
  134.  
  135.         majordomo@via.ecp.fr
  136.  
  137.     with in *BODY*:
  138.  
  139.         subscribe lyx
  140.         end
  141.  
  142.     To contribute to the mailing list, mail to
  143.  
  144.         lyx@via.ecp.fr
  145.  
  146.     Please send unsubscription messages to majordomo@via.ecp.fr only!
  147.  
  148.     This mailing list is mirrored and archived on the Web at
  149.  
  150.             http://www.via.ecp.fr/~andre/lyx/archive/
  151.  
  152. Other Internet resources of relevance to LyX
  153.  
  154.     Main LyX archive site:
  155.     ftp://ftp.via.ecp.fr/pub/lyx/
  156.  
  157.     The LyX homepage contains valuable information, including links
  158.     to other LyX homepages around the world:
  159.     http://la1ad.uio.no/lyx/
  160.  
  161.     Other LyX archive sites are available at:
  162.     ftp://fiwi02.wiwi.uni-tuebingen.de/pub/LyX/
  163.     ftp://ftp.ibp.fr/pub/lyx/
  164.     ftp://ftp.sdsc.edu/pub/other/lyx/
  165.     ftp://ftp.fciencias.unam.mx/pub/Lyx/
  166.  
  167.     The latest development source can sporadically be found at:
  168.     ftp://la1ad.uio.no/pub/lyx/
  169.     http://la1ad.uio.no/lyx/
  170.  
  171.     The user's mailing list is archived at:
  172.     http://bioclox.bot.biologie.uni-tuebingen.de/
  173.             mailing-archive/lyxlist/maillist.html
  174.  
  175.     The developer's mailing list is archived at:
  176.         http://www.via.ecp.fr/~andre/lyx/archive/
  177.  
  178. How is the numbering scheme for releases? Like the Linux kernel?
  179.  
  180.     Yes, it's like the Linux kernel since LyX version 0.8:
  181.  
  182.         0.8.x, 0.10.x, 0.12.x ... are stable, public releases
  183.         0.9.x, 0.11.x, 0.13.x ... are developer releases
  184.  
  185.     Of course you may also use the developer releases, but only
  186.     at your own risk. This is definitely higher than your risk when 
  187.     using the public releases, even if this is your own risk, too.
  188.     
  189.     Sometimes, things called "snapshots" are released. Those are
  190.     developer releases, so stay away from those unless you feel
  191.     adventurous and want to help finding bugs.
  192.  
  193. You may get updates and patches via anonymous ftp from
  194.  
  195.     ftp://ftp.via.ecp.fr/pub/lyx/incoming/
  196.  
  197.     See above for mirrors.
  198.  
  199.     You can also try Henner Zeller's Patch-Tracker at
  200.  
  201.     http://lemming.stud.fh-heilbronn.de/~zeller/lyxpatchlist.html
  202.  
  203. How do I apply a patch?
  204.  
  205.     Go to the root of the source distribution and type:
  206.     
  207.         patch -p1 -E <../name_of_patch
  208.  
  209.     if the unpacked patch-file is in the directory above.
  210.  
  211.     Sometimes, the patch will not work as intended, so do a 
  212.  
  213.         find . -name '*.rej' 
  214.  
  215.     to see if you had any rejects. Often the rejects are cosmetical,
  216.     but sometimes you need to fix them by hand. Other times, that can
  217.     be very difficult, so just wait for the next release. They come 
  218.     every other week or so.
  219.  
  220. How do I submit a bug report?
  221.  
  222.     If possible, read the "Known Bugs" document found under the
  223.     Help menu.  You'll find detailed info on submitting bug reports
  224.     there.
  225.  
  226.     You should also check the BUGS file in this directory.
  227.  
  228.     If you can't do that, send details to lyx@via.ecp.fr.  Don't forget
  229.     to mention which version you are having problems with!
  230.  
  231. How do I prepare a binary distribution for the use of others?
  232.  
  233.     1) Compile LyX with the right compiler switches for your
  234.     architecture. In particular you might want to ensure that libraries
  235.     like xforms and xpm are statically linked. To this end, you
  236.     can use a command like
  237.  
  238.         make LYX_LIBS='/foo/libforms.a /bar/libXpm.a'
  239.  
  240.     Moreover, make sure you use the --without-latex-config switch
  241.     of configure, since others might not be interested by your
  242.     configuration :-) 
  243.  
  244.     2) Create a file README.bin describing your distribution and
  245.     referring to *you* if problems arise. As a model, you can use the 
  246.     file development/tools/README.bin.example which was originally
  247.     written for Linux by David L. Johnson. Do *not* use directly
  248.     the file in the distribution, since it refers to Linux and
  249.     points to David L. Johnson for help. However, it can be a good
  250.     starting point. Note that removing the file completely is
  251.     better than not    editing it at all.
  252.  
  253.     3) Type `make bindist'. This will create a file
  254.     lyx-0.xx.yy-bin.tar.gz. Rename it to reflect you architecture 
  255.     and the peculiarities of your build (e.g. static vs. dynamic).
  256.  
  257.     4) Check that everything is correct by unpacking the distribution 
  258.     in some private place and running it. In particular, check the 
  259.     output of `ldd lyx' to know which libraries are really needed.
  260.  
  261.     5) Upload your binary file to ftp.via.ecp.fr:/pub/lyx/uploads.
  262.  
  263. How can I participate in the development of LyX? 
  264.  
  265.     Any help with the development of LyX is greatly appreciated--
  266.     after all LyX wouldn't be what it is today without the help
  267.     of volunteers. We need your help!
  268.  
  269.     The LyX project was started by Matthias Ettrich in 1995, and
  270.     has since then grown from his single efforts on Linux to a 
  271.     project involving many people on different platforms in
  272.     different countries.
  273.  
  274.     In the beginning, Matthias took care of the code base and
  275.     patches were sent to him personally, but as the project
  276.     grew, he handed over the maintenance job to Lars Gullik
  277.     Bjoennes, so he could spent more time hacking the code.
  278.     
  279.     Since spring 1996, Lars has maintained the code, but once
  280.     again the project outgrew the structure, so in the summer 
  281.     of 1996, the documentation effort was handed over to 
  282.     John Weiss, who organized this part of LyX until fall 1997,
  283.     where he stepped down as organizer after reorganizing the entire 
  284.     documentation.
  285.  
  286.     Now, the documentation is maintained collectively.
  287.         
  288.     If you want to work on LyX, you should contact the developer's 
  289.     mailing list for discussion on how to do your stuff.  LyX is being 
  290.     cleaned up, and therefor it's important to follow some rules. 
  291.     Read about those rules in development/Code_rules/.
  292.  
  293.     Notice that other contributions to the LyX project in general,
  294.     such as *external* code don't fall in this category and can be 
  295.     written in whatever way preferred.
  296.  
  297.     Patches for the main source tree should be prepared with the 
  298.     makepatch utility found in
  299.  
  300.         development/tools/makepatch
  301.  
  302.     and should be done against the latest version of LyX with
  303.     all other patches applied.
  304.     
  305.     Every patch should update the CHANGES file at the top only, and 
  306.     maybe also the CREDITS file.
  307.  
  308.     If you feel confident that the patch doesn't break anything,
  309.     and it's not covered by one of the above areas, you should mail
  310.     the uuencoded patch prepared by makepatch to
  311.  
  312.         lyxpatches@via.ecp.fr
  313.  
  314.     and then send a mail to the developer's mailing list 
  315.     at lyx@via.ecp.fr describing the changes when you've 
  316.     confirmed that the file arrived safely at via.ecp.fr 
  317.     (check the file size in the receipt mail).
  318.  
  319. Thank you for trying LyX, and we appreciate your feedback in the mailing
  320. lists.
  321.  
  322. The LyX Team.
  323. (lyx@via.ecp.fr)
  324.