====================
CAPI demo readme.txt
====================

Greetings and thanks for trying the CAPI demo applications.

This file contains information you may find useful to read before 
running the demos.


Demos included
--------------
addevent_cgi
    This is a demo of how to use CAPI_WebLogon to interact with some
    Steltor web clients. addevent_cgi should be run as a CGI application.
    * NOTE: this demo uses CAPI_WebLogon() which is not compatible with
    some Steltor web clients and is not recommended.


calendar
    A simple calendar applicaton that uses most of the functions in CAPI.


callback_stream
    Shows how to use "callback" streams with CAPI.


ct2html
    Builds an HTML page that shows free/busy times in one or more agendas.


file_stream
    Shows how to use "file" streams with CAPI.

    
memory_stream
    Shows how to use "memory" streams with CAPI.


vb_bindings (Windows package only)
    This demonstrates how to make Visual Basic bindings
    for CAPI so that Visual Basic applications can use CAPI.
    


Compiling
--------- 
    Unix:
        Each demo directory contains a GNU make-compatible
        makefile.  cd to each demo directory, then type 'gmake'.
        The executables should be found in a subdirectory corresponding
        to your platform (i.e. AIX/, Linux/, HP-UX/, SunOS/)
        
        If you don't have gmake, then you will have to modify the
        makefiles and the file make-unix/common.mk (which is included
        by the other makefiles).

    Windows:
        A Microsoft Visual C++ 6.0 workspace (demo.dsw) has been
        included with projects for each demo.  The executables
        will be placed in each demo's directory (e.g. calendar/Release).
        
    Mac:
        A Metrowerk's CodeWarrior project (demo.mcp) has been included with
        targets for each demo.  The executables will be placed in each
        demo's directory (e.g. calendar:Release).
        
Running
-------
All CAPI applications need to be able to access the following 
Steltor runtime libraries:

    capi
    ctimpexp
    ctcalcli
    ctcore

The actual names of the shared libraries are platform dependant.
(e.g. capi.dll, libcapi.so, libcapi.sl).

On most platforms, you can set an environment variable to point to the
directory where these libraries are located:
    Sun, Linux: LD_LIBRARY_PATH
    HP-UX:      SHLIB_PATH
    AIX:        LIBPATH
    Windows:    PATH


Making your own CAPI application
--------------------------------
Every CAPI application should:

1)  define "CAPI_FUNC(a)" before including the CAPI header file.
    Have a look at the demos for an example on how to do this.

2)  include "ctapi.h"

3)  link with the Steltor shared libraries listed above.


