diff options
| author | Michael Drake <michael.drake@codethink.co.uk> | 2020-02-21 09:31:47 +0000 |
|---|---|---|
| committer | Michael Drake <michael.drake@codethink.co.uk> | 2020-02-21 09:31:47 +0000 |
| commit | 12af8617f804f761a9d5a8efd4a4c2499dd63e52 (patch) | |
| tree | 30b907ac03de0cf7b145d7ac24f46e4c267051e5 /README | |
| parent | 4ba326d71d09eecd005782f264b1832d10f095b2 (diff) | |
| download | netsurf-12af8617f804f761a9d5a8efd4a4c2499dd63e52.tar.gz netsurf-12af8617f804f761a9d5a8efd4a4c2499dd63e52.tar.bz2 | |
README: Convert to markdown.
Diffstat (limited to 'README')
| -rw-r--r-- | README | 47 |
1 files changed, 17 insertions, 30 deletions
@@ -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) |