Generating the API documention
------------------------------

1. Generate the API documentation using the doxygen tool.

   $ doxygen

   The documentation will be generated as HTML in the html/ directory.

Building and installing on Linux
--------------------------------

1. Build the module using the 'generic' configuration.

   $ linux/build generic

3. Install the module.

   $ sudo linux/build generic install

Available configurations:

generic        Host running Linux kernel 2.6.x
arm-linux      arm-linux target running 2.6.x (must specify KDIR)

These configurations are specified in makefile fragments named
config.<config>.mk.

Useful variables include:

  Variable       Description                               Default
  KDIR           path to kernel source tree                /lib/modules/`uname -r`/build
  ARCH           kernel architecture (e.g., ARM)           unset
  CROSS_COMPILE  cross compiler prefix (e.g., arm-linux-)  unset
  O              Kbuild's O (output directory) option      unset
  V              Kbuild's V (verbosity) option             unset
  prefix         Installation tree prefix                  /usr/local

Additional configurations can be created to set any required variables
before including the appropriate generic configuration.  For example,
for an arm-linux build (with the kernel in ~/work/linux-2.6.16.28):

  KDIR := $(HOME)/work/linux-2.6.16.28

  include config.arm-linux.mk

Variables can also be specified on the command line.

  $ ./build generic V=1

Building and installing on Zoran SDK
------------------------------------

1. Patch the Zoran SDK.

   > zoran\build <PATH_TO_ZORAN_SDK>

where <PATH_TO_ZORAN_SDK> is Windows path to Zoran SDK (e.g. C:\HceReleaseC10).

2. Build the Zoran HCE firmware as usual from <PATH_TO_ZORAN_SDK>\Main folder.

In order to clean the patches from the Zoran SDK use

   > zoran\build <PATH_TO_ZORAN_SDK> clean

  
