view libfaim/README @ 1324:faee6f18b2a8

[gaim-migrate @ 1334] Woops committer: Tailor Script <[e-mail]>

libfaim pre-0.90 or so
----------------------

This is libfaim, the purpose of which is to implement as much as the
AOL AIM/OSCAR protocol as possible (which should be all of it).  After
over two years of development, its still nowhere close.  

This is not a full client and never will be.  libfaim only implements
the routines to implement a client (ie, there's no user interface).  

Status
------

I would not recommend using this version of libfaim in any form yet.  It's
beta-quality and I know it leaks memory quite badly.  It seems fairly
stable, however.  YMMV, YAYOR, etc.  I suppose I should say regardless of
that warning, that several clients use it and people use those clients
on a daily basis (in particular, me).  Also, you're probably reading this 
from a CVS version, since I haven't made a release in a very long time.  
The CVS version changes fairly rapidly when I'm in the mood, so a version
you checked out an hour ago may be better or worse than a version you 
check out now.  


Building
--------

Everything in this libfaim dist should build cleanly on any UNIX(-like)
operating system.  Originally developed on Linux+glibc.  Past versions 
known to work on Linux+libc5, FreeBSD, HP/UX, Solaris, Mac OS X Server, 
Win32 using VC++ 98/6 and others.

libfaim builds as both libfaim.a and libfaim.so.  If your platform for
some reason does not support dynamic libraries (eg, you get errors when
building libfaim.so), you'll have to tweak the makefiles a bit to get
the utils/ directory to build.  

Otherwise, just do a 'make'.  I don't believe I use any specific features
GNU make, but if something fails, make sure you have it.  And bash too.


Accessories
-----------

In utils/, you'll find a few things extra:

  faimtest:   very rudimentary front-end.  no user interface, but does
              illustrate the basics of logging in and sending/recieving
              messages and buddy list notifications.  Potential front-
              end authors start here.

  aimpasswd:  utility to change an AIM password without using a full
              client.  Note that at the time of this writing, this
              didn't work quite right yet.  See the top of the code for
              latest status.

License
-------

libfaim is covered under my copyright under the terms of the Lesser GNU
Public License, as documented in the file COPYING in the top level directory.


Documentation
-------------

Unfortunatly, there is not currently any documentation on the libfaim API.
Use the source and utils/faimtest/faimtest.c as a reference when coding
front-ends.  

Mailing Lists
-------------

Thanks to Sourceforge, we have our mailing lists back. See:
http://www.sourceforge.org/mail/?group_id=920  for instructions
on subscribing to the lists:

  libfaim-devel: Discussion of libfaim and its developement.
  libfaim-aim-protocol: Discussion of the finer points of OSCAR hacking
 

Contact Info
------------

The author (Adam Fritzler), can be reached at [e-mail].

Front-end information:
  http://www.auk.cx/faim/
Protocol information:
  http://www.auk.cx/faim/protocol/