doc/README

   1                         Overview of the ELinks documentation
   2
   3 There is only limited documentation available for ELinks so far, sorry. It
   4 basically consists of the documents in this directory and the features.conf,
   5 README and INSTALL files in the project's root directory.
   6
   7 The files you will find in this directory are manpages 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?) documents. The index.txt
  10 file contains the table of contents which should help you navigating between
  11 the files.
  12
  13 Tools
  14 -----
  15
  16 The manual is written in asciidoc, however you will also need xmlto to process
  17 docbook XML generated by asciidoc into manpages and the html-chunked manual.
  18 If you want to translate .pod files you need pod2html.
  19
  20 All these tools are checked by configure, thus to successfully build all the
  21 possible documentation (with the tools available on the system), just run
  22
  23         $ make all-docs
  24
  25 in the doc/ directory.
  26
  27 Contributing
  28 ------------
  29
  30 Contributions are very warmly welcomed, whether it is fixing typos or bad
  31 grammar, rewritings or new material. Any information relevant to ELinks usage
  32 can be included in the manual, including FAQ material, tips and cheats ;)
  33
  34 There is no strict codingstyle, but please don't limit your use of whitespaces
  35 and take a look at the style used in the current documents to get ideas of what
  36 is reasonable.
  37
  38 Contributions should be sent to Jonas Fonseca <fonseca@diku.dk> or to the
  39 ELinks mailing list. If you are changing something in an existing document,
  40 please read about how to make unified patches in the Patches section of the
  41 doc/hacking.txt file.
  42