summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMichael Drake <michael.drake@codethink.co.uk>2020-05-24 17:50:15 +0100
committerMichael Drake <michael.drake@codethink.co.uk>2020-05-24 17:50:15 +0100
commit57e3b0cdbf284fcd8e3f3af36ff1cab0115b0b2a (patch)
treec05cce9960d69c9ee4a98a80bd90479e91ee611f /README.md
parent7f0b3110bbd730876a8cacba13a2acafdba57058 (diff)
downloadnetsurf-all-57e3b0cdbf284fcd8e3f3af36ff1cab0115b0b2a.tar.gz
netsurf-all-57e3b0cdbf284fcd8e3f3af36ff1cab0115b0b2a.tar.bz2
README: Add .md file extension.
Diffstat (limited to 'README.md')
-rw-r--r--README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2575151
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+NetSurf source -- Web Browser and all associated support libraries
+==================================================================
+
+Overview
+--------
+
+NetSurf is a compact graphical web browser which aims for HTML5, CSS
+and JavaScript support.
+
+This complete source package contains all the required NetSurf
+support libraries to build the browser.
+
+Binaries
+--------
+
+The NetSurf project provide binary builds for releases for several
+platforms form the website and have packaged the browser in several
+distributions. This option may be more suitable for some users than
+compiling from source.
+
+Compilation
+-----------
+
+A simple "make" is sufficient to compile the browser with the
+default gtk toolkit selection.
+
+It depends upon the host system having a suitable toolchain for
+compiling c programs installed along with GNU make, zlib, flex,
+bison and lipjpeg
+
+In addition to the core library dependencies it is strongly
+recommended libcurl, openssl and libpng libraries are present or the
+browser will not have HTTP fetches, HTTPS fetches and PNG graphics
+support respectively.
+
+There are multiple GUI toolkits available which all have additional
+dependencies i.e. gtk browser frontend requires the gtk development
+libraries.