summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README47
1 files changed, 17 insertions, 30 deletions
diff --git a/README b/README
index f983b9e27..a6b688430 100644
--- a/README
+++ b/README
@@ -1,40 +1,27 @@
---------------------------------------------------------------------------------
- NetSurf README
---------------------------------------------------------------------------------
+NetSurf
+=======
- This document should help point you at various useful bits of information.
+This document should help point you at various useful bits of information.
- Building NetSurf
-==================
-
- Read the QUICK-START document in the Docs/ directory for instructions.
+Building NetSurf
+----------------
+Read the [Quick Start](docs/quick-start.md) document for instructions.
- Creating a new port
-=====================
- Look at the existing front ends for example implementations. The framebuffer
- front end is simplest and most self-contained. Also, you can contact the
- developers for help:
+Creating a new port
+-------------------
- http://www.netsurf-browser.org/contact/
+Look at the existing front ends for example implementations.
+The framebuffer front end is simplest and most self-contained.
+Also, you can [contact the developers](http://www.netsurf-browser.org/contact/)
+for help.
- Check out the developer documentation sources listed below too.
+Further documentation
+---------------------
- Further documentation
-=======================
-
- The Developer section of the web site has loads of info to get you started:
-
- http://www.netsurf-browser.org/developers/
-
- General documentation on how NetSurf's code works can be found on the
- development wiki:
-
- http://wiki.netsurf-browser.org/Documentation/
-
- The code style guide is here:
-
- http://www.netsurf-browser.org/developers/StyleGuide.pdf
+* [Developer documentation](http://www.netsurf-browser.org/developers/)
+* [Developer wiki](http://wiki.netsurf-browser.org/Documentation/)
+* [Code style guide](http://www.netsurf-browser.org/developers/StyleGuide.pdf)