summaryrefslogtreecommitdiff
path: root/README.md
blob: 8f384304278ebd6f159127884c8b9bcce4adb0c2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
NetSurf
=======

This document should help point you at various useful bits of information.


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](https://www.netsurf-browser.org/contact/)
for help.


Further documentation
---------------------

* [Developer documentation](https://www.netsurf-browser.org/developers/)
* [Developer wiki](https://wiki.netsurf-browser.org/Documentation/)
* [Code style guide](https://www.netsurf-browser.org/developers/StyleGuide.pdf)