diff options
author | Michael Drake <tlsa@netsurf-browser.org> | 2009-08-09 21:01:43 +0000 |
---|---|---|
committer | Michael Drake <tlsa@netsurf-browser.org> | 2009-08-09 21:01:43 +0000 |
commit | f7bba441db95a86012fd90b7a4e0312a092ecb3d (patch) | |
tree | 41fa6b38a8b27cc8ca6c7c11c07c42c7a5b634af /README | |
parent | 33e3b053e44f13f464d6c1fc1b665f0891eda255 (diff) | |
download | netsurf-f7bba441db95a86012fd90b7a4e0312a092ecb3d.tar.gz netsurf-f7bba441db95a86012fd90b7a4e0312a092ecb3d.tar.bz2 |
Move README from Docs/ to root.
svn path=/trunk/netsurf/; revision=9136
Diffstat (limited to 'README')
-rw-r--r-- | README | 66 |
1 files changed, 66 insertions, 0 deletions
@@ -0,0 +1,66 @@ +-------------------------------------------------------------------------------- + NetSurf README 09 August 2009 +-------------------------------------------------------------------------------- + + This document should help point you at various useful bits of information. + + + For NetSurf Users +=================== + + Most of the documentation you'll need to use NetSurf is in the documentation + section of the web site: + + http://www.netsurf-browser.org/documentation/ + + If you need to build NetSurf yourself, read the Building bit of the 'For + NetSurf Developers' section below. + + + For NetSurf Developers +======================== + + If there is already a port of NetSurf to your platform you can build it + following the platform specific build instructions. If not, you will have + to port NetSurf. + + Finally, there are various links to NetSurf developer documentation at the + bottom. + + Building +---------- + + Look at the appropriate BUILDING-* document in the Docs/ directory for + instructions. + + Note, if you want to do a native RISC OS build, the instructions are on + the web site instead: + + http://www.netsurf-browser.org/documentation/robuild + + Porting +--------- + + Look at the existing front ends for example implementations. Also, you can + contact the developers for help: + + http://www.netsurf-browser.org/contact/ + + Check out the developer documentation sources listed below too. + + + 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 |