diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 000000000..8f3843042 --- /dev/null +++ b/README.md @@ -0,0 +1,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) |