Merge with git+ssh://pasky.or.cz/srv/git/elinks.git
[elinks.git] / README
blobb54d4a06b83cdda93dea514cf243d7f4cea1d292
1 ELinks - an advanced web browser
2 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4 ELinks is an advanced and well-established feature-rich text mode web
5 (HTTP/FTP/..) browser. ELinks can render both frames and tables, is highly
6 customizable and can be extended via scripts. It is very portable and runs
7 on a variety of platforms.
9 The ELinks official website is available at
11         http://elinks.cz/
13 Please see the SITES file for mirrors or other recommended sites.  If you
14 want to install ELinks on your computer, see the INSTALL file for further
15 instructions.
17 A good start point is documentation files available in doc/, especially the
18 file named index.txt.
20 If you want to request features or report bugs, see community information at
21 http://elinks.cz/community.html and feedback information available at
22 http://elinks.cz/feedback.html.
24 If you want to write some patches, please first read the doc/hacking.txt
25 document.
27 If you want to add a new language or update the translation for an existing
28 one, please read po/README document.
30 If you want to write some documentation, well, you're welcome! ;)
34 Historical notes
35 ~~~~~~~~~~~~~~~~
37 Initially, ELinks was a development version of Links (Lynx-like text WWW
38 browser), with more liberal features policy and development style.  Its purpose
39 was to provide an alternative to Links, and to test and tune various new
40 features, but still provide good rock-solid releases inside stable branches.
42 Why not contribute to Links instead?  Well, first I made a bunch of patches for
43 the original Links, but Mikulas wasn't around to integrate them, so I started
44 releasing my fork. When he came back, a significant number of them got refused
45 because Mikulas did not like them, as he just wouldn't have any use for them
46 himself.  He wants to keep Links with a relatively closed feature set and merge
47 only new features which he himself needs.  It has advantages that the tree is
48 very narrow and the code is small and contains very little bloat.
50 ELinks, on the contrary, aims to provide a full-featured web browser, superior
51 to both lynx and w3m and with the power (but not slowness and memory usage) of
52 Mozilla, Konqueror and similar browsers. However, to prevent drastic bloating
53 of the code, the development is driven in the course of modularization and
54 separation of add-on modules (like cookies, bookmarks, ssl, scripting etc).
56 For more details about ELinks history, please see
58         http://elinks.cz/history.html
60 If you are more interested in the history and various Links clones and versions,
61 you can examine the website at
63         http://links.sf.net/
68 vim: textwidth=80