doc/README

   1                         Overview of the ELinks documentation
   2
   3 There is only limited documentation available for ELinks, sorry. It basically
   4 consists of the documents in this directory and the features.conf, README and
   5 INSTALL files in the project's root directory.
   6
   7 The files you will find in this directory are the man pages living in the man/
   8 directory and a bunch of .html and especially .txt (wait, you expect HTML
   9 browser to carry its documentation around in HTML?). The index.txt file
  10 contains the table of contents listing all these files.
  11
  12 Tools
  13 -----
  14
  15 The manual is written in asciidoc. However you will also need xmlto to process
  16 docbook XML generated by asciidoc into manpages and the html-chunked manual.  If
  17 you want to translate .pod files you need pod2html.
  18
  19 All these tools are checked by configure so that to successfully build all
  20 possible documentation (with the tools available on the system) run
  21
  22         $ make all-docs
  23
  24 in the doc/ directory.
  25
  26 Contributing
  27 ------------
  28
  29 Contributions are very warmly welcomed. Wether it be fixing of typos or bad
  30 grammar, rewritings or new material. All info relevant to ELinks usage can be
  31 included in the manual. Including FAQ material, tips and cheats ;)
  32
  33 There is no strict codingstyle. But please don't limit your use of whitespace
  34 and take a look at the style used in the current documents to get ideas of what
  35 is reasonable.
  36
  37 Contributions should be sent to Jonas Fonseca <fonseca@diku.dk>. If your changing
  38 something in an existing document please read about how to make unified patches
  39 in the Patches section of the doc/hacking.txt file.
  40
  41 $Id: README,v 1.14 2005/05/24 19:05:14 jonas Exp $