home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / lyx21041.zip / XFree86 / lib / X11 / lyx / doc / README.Documentation < prev    next >
Text File  |  1998-12-23  |  1KB  |  42 lines
  1. README.Documentation
  2.  
  3. by John Weiss [5/97] weissjp@colorado.edu
  4.  
  5.  
  6. ================
  7. Introduction
  8.  
  9.     The purpose of this file is, primarily, to provide a style sheet
  10.     and helpful hints to those wishing to help with the documentation
  11.     project.  If you're actually looking for documentation, there are
  12.     7 files in LyX format which you can read from within LyX.  Check
  13.     out the Help menu to read the Introduction.  It's a good place to 
  14.     start.
  15.  
  16. ================
  17. Why a separate documentation project?  Can't the developers do it?
  18.  
  19.     In a word, no.  They're too busy adding features and squishing
  20.     bugs.
  21.  
  22.     Also, g++ is far more forgiving of style changes than a human
  23.     brain.  As long as the code is correct, g++ will happilly compile
  24.     it, and compile it the same way from machine to machine.  Human
  25.     brains are far less forgiving and far more individualized.  So,
  26.     the documentation needs to all be in a uniform style, in addition
  27.     to being grammatically correct and easily readable.  That's a
  28.     pretty big undertaking - which is why I volunteered to
  29.     administrate the docs in the first place!  Lars has enough to do
  30.     maintaining the code, anyways!
  31.  
  32. ================
  33. Helping Out
  34.  
  35.     If you'd like to contribute to the Documentation Project, please
  36.     read the file Intro.lyx.  It now contains all of the information
  37.     you'll need to get started.
  38.  
  39.  
  40. John Weiss
  41. 5/97
  42.