README

   1
   2 libfaim pre-0.90 or so
   3 ----------------------
   4
   5 This is libfaim, the purpose of which is to implement as much as the
   6 AOL AIM/OSCAR protocol as possible (which should be all of it).  After
   7 over two years of development, its still nowhere close.
   8
   9 This is not a full client and never will be.  libfaim only implements
  10 the routines to implement a client (ie, there's no user interface).
  11
  12 Status
  13 ------
  14
  15 I would not recommend using this version of libfaim in any form yet.  It's
  16 beta-quality and I know it leaks memory quite badly.  It seems fairly
  17 stable, however.  YMMV, YAYOR, etc.  I suppose I should say regardless of
  18 that warning, that several clients use it and people use those clients
  19 on a daily basis (in particular, me).  Also, you're probably reading this
  20 from a CVS version, since I haven't made a release in a very long time.
  21 The CVS version changes fairly rapidly when I'm in the mood, so a version
  22 you checked out an hour ago may be better or worse than a version you
  23 check out now.
  24
  25
  26 Building
  27 --------
  28
  29 Everything in this libfaim dist should build cleanly on any UNIX(-like)
  30 operating system.  Originally developed on Linux+glibc.  Past versions
  31 known to work on Linux+libc5, FreeBSD, HP/UX, Solaris, Mac OS X Server,
  32 Win32 using VC++ 98/6 and others.
  33
  34 libfaim builds as both libfaim.a and libfaim.so.  If your platform for
  35 some reason does not support dynamic libraries (eg, you get errors when
  36 building libfaim.so), you'll have to tweak the makefiles a bit to get
  37 the utils/ directory to build.
  38
  39 Otherwise, just do a 'make'.  I don't believe I use any specific features
  40 GNU make, but if something fails, make sure you have it.  And bash too.
  41
  42
  43 Accessories
  44 -----------
  45
  46 In utils/, you'll find a few things extra:
  47
  48   faimtest:   very rudimentary front-end.  no user interface, but does
  49               illustrate the basics of logging in and sending/recieving
  50               messages and buddy list notifications.  Potential front-
  51               end authors start here.
  52
  53   aimpasswd:  utility to change an AIM password without using a full
  54               client.  Note that at the time of this writing, this
  55               didn't work quite right yet.  See the top of the code for
  56               latest status.
  57
  58 License
  59 -------
  60
  61 libfaim is covered under my copyright under the terms of the Lesser GNU
  62 Public License, as documented in the file COPYING in the top level directory.
  63
  64
  65 Documentation
  66 -------------
  67
  68 Unfortunatly, there is not currently any documentation on the libfaim API.
  69 Use the source and utils/faimtest/faimtest.c as a reference when coding
  70 front-ends.
  71
  72 Mailing Lists
  73 -------------
  74
  75 Thanks to Sourceforge, we have our mailing lists back. See:
  76 http://www.sourceforge.org/mail/?group_id=920  for instructions
  77 on subscribing to the lists:
  78
  79   libfaim-devel: Discussion of libfaim and its developement.
  80   libfaim-aim-protocol: Discussion of the finer points of OSCAR hacking
  81
  82
  83 Contact Info
  84 ------------
  85
  86 The author (Adam Fritzler), can be reached at mid@auk.cx.
  87
  88 Front-end information:
  89   http://www.auk.cx/faim/
  90 Protocol information:
  91   http://www.auk.cx/faim/protocol/
  92