Go to file
Michael Drake 77c6009c86 Remove overview document which has already been migrated to the wiki. The rest will follow.
svn path=/trunk/netsurf/; revision=8851
2009-07-28 13:10:41 +00:00
!NetSurf Updated version from Samir Hawamdeh 2009-07-26 16:26:24 +00:00
Docs Remove overview document which has already been migrated to the wiki. The rest will follow. 2009-07-28 13:10:41 +00:00
amiga Fix RISC OS and Amiga builds. 2009-07-27 18:01:54 +00:00
beos Merge LibCSS port to trunk. 2009-07-23 23:05:34 +00:00
content Merge LibCSS port to trunk. 2009-07-23 23:05:34 +00:00
css Add stylesheet size + size of imported sheets onto CSS content size. 2009-07-27 19:40:55 +00:00
desktop Port r8808 to trunk. 2009-07-27 14:58:06 +00:00
framebuffer Merge LibCSS port to trunk. 2009-07-23 23:05:34 +00:00
gtk Fix font config stuff 2009-07-24 00:43:02 +00:00
image Correct include. 2009-07-23 23:50:35 +00:00
render Include size of lwc_context in content size. 2009-07-28 00:21:36 +00:00
riscos Fix RISC OS and Amiga builds. 2009-07-27 18:01:54 +00:00
utils Merge LibCSS port to trunk. 2009-07-23 23:05:34 +00:00
COPYING Clarify licensing arrangements 2007-08-09 15:32:39 +00:00
Makefile Merge LibCSS port to trunk. 2009-07-23 23:05:34 +00:00
Makefile.config.example Update build config example comment. 2009-03-27 14:26:43 +00:00
Makefile.defaults NETSURF_USE_DRAW should apply to the Draw content handler only. 2009-06-20 19:38:56 +00:00
Makefile.resources Use progress pointer. 2009-07-14 16:18:35 +00:00
Makefile.sources Merge LibCSS port to trunk. 2009-07-23 23:05:34 +00:00
netsurf Remove bashism and improve nsgtk launcher shell script, add simple BUILDING-GTK document. 2007-02-06 16:52:47 +00:00

Docs/README

--------------------------------------------------------------------------------
  NetSurf README                                                  28 July 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 this 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