doc/README_en

   1 This is the Cinelerra CV Manual.\r
   2 \r
   3 You may redistribute it and/or modify it under the terms of the GNU General\r
   4 Public License, as published by the Free Software Foundation; either version 2\r
   5 of the License, or (at your option) any later version.\r
   6 \r
   7 It is based on "Secrets of Cinelerra", an excellent manual written by Heroine\r
   8 Virtual Ltd. Alex Ferrer's TWiki contents was put in by Nicolas Maufrais, who\r
   9 worked on the original cinelerra.texi file in order to generate nice manuals.\r
  10 \r
  11 To fetch the manual sources:\r
  12 cg-clone git://scm.pipapo.org/cinelerra-nicolasm\r
  13 \r
  14 Maintainers of the Cinelerra-CV documentation :\r
  15 English : Nicolas Maufrais (Coodinator) - e.conti@gmx.net\r
  16 French : Jean-Luc Coulon\r
  17 \r
  18 To make the manuals in PDF, HTML and TXT formats, just execute:\r
  19 ./make_manuals.sh <language code>\r
  20 Example: ./make_manuals.sh en\r
  21 \r
  22 Dependency: texinfo has to be installed on your computer.\r
  23 \r
  24 The manual can also be converted to Docbook, but you need the CVS version of\r
  25 texinfo to do so. The "stable" version of Texinfo cannot produce a correct\r
  26 Docbook file. If you have the binary of the CVS version of makeinfo available\r
  27 on your computer, you can uncomment the corresponding lines in make_manuals.sh\r
  28 That will produce a Docbook cinelerra.xml file which can be opened by yelp.\r
  29 CAUTION: Do not deinstall your current stable version of texinfo. If you want\r
  30 to look at the manual in yelp, just download the texinfo CVS sources and make\r
  31 the binaries. Here is what you should do:\r
  32 $ cvs -z3 -d:pserver:anonymous@cvs.savannah.gnu.org:/sources/texinfo co texinfo\r
  33 $ cd texinfo\r
  34 $ ./autogen.sh\r
  35 $ ./configure --enable-maintainer-mode\r
  36 $ make\r
  37 \r
  38 You will get compilation errors. Do not worry about that. Do *NOT* proceed to\r
  39 the makeinfo CVS install. All you need is the makeinfo binary, which is in the\r
  40 makeinfo folder.  Rename it to makeinfo_cvs for example and copy it your path.\r