netsurf/Docs
Michael Drake 33e3b053e4 Say BUILDING docs are in the Docs directory.
svn path=/trunk/netsurf/; revision=9135
2009-08-09 20:59:46 +00:00
..
ideas Sketch out a rendering library 2008-07-08 19:43:52 +00:00
BUILDING-AmigaOS Minor corrections for libcss build 2009-07-26 16:23:34 +00:00
BUILDING-BeOS Remove mention of re2c and lemon. Still need to update with LibCSS and wapcaplet info. 2009-07-23 23:25:51 +00:00
BUILDING-Framebuffer Remove mention of re2c and lemon. Still need to update with LibCSS and wapcaplet info. 2009-07-23 23:25:51 +00:00
BUILDING-GTK Mention how to get LibCSS. 2009-07-24 21:47:31 +00:00
BUILDING-ROCross Update RISC OS cross building notes. 2009-08-01 17:56:14 +00:00
Doxyfile Purge WITH_SEARCH 2009-02-22 15:21:54 +00:00
PACKAGING-GTK Fix typos, fix libharu address and update homepage setting. 2008-07-30 12:02:10 +00:00
README Say BUILDING docs are in the Docs directory. 2009-08-09 20:59:46 +00:00

--------------------------------------------------------------------------------
  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