README: Convert to markdown.

This commit is contained in:
Michael Drake 2020-02-21 09:31:47 +00:00
parent 4ba326d71d
commit 12af8617f8

39
README
View File

@ -1,40 +1,27 @@
-------------------------------------------------------------------------------- NetSurf
NetSurf README =======
--------------------------------------------------------------------------------
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 Building NetSurf
================== ----------------
Read the QUICK-START document in the Docs/ directory for instructions. Read the [Quick Start](docs/quick-start.md) document for instructions.
Creating a new port Creating a new port
===================== -------------------
Look at the existing front ends for example implementations. The framebuffer Look at the existing front ends for example implementations.
front end is simplest and most self-contained. Also, you can contact the The framebuffer front end is simplest and most self-contained.
developers for help: Also, you can [contact the developers](http://www.netsurf-browser.org/contact/)
for help.
http://www.netsurf-browser.org/contact/
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: * [Developer documentation](http://www.netsurf-browser.org/developers/)
* [Developer wiki](http://wiki.netsurf-browser.org/Documentation/)
http://www.netsurf-browser.org/developers/ * [Code style guide](http://www.netsurf-browser.org/developers/StyleGuide.pdf)
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