README 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. 2006-March-13
  2. CIRCAPI .01-Alpha (pre-release) Snapshot
  3. HOW TO COMPILE:
  4. make circapi && make raw_irc_example && make circapi_client
  5. HOW TO CONTRIBUTE YOUR MODIFICATIONS:
  6. send a modification request to dmolieri@users.sourceforge.net along with the
  7. verbosely commented code and purpose. Keep in mind, I have no official contributors
  8. right now, so I change major things at will, if you choose to add a modification or
  9. bug fix or apply something, it's important you notify me so I can impliment the changes
  10. before I change everything on you! :)
  11. Developer Notes-
  12. This is not a revision of circapi, this is an extension of .01-Alpha with new features added
  13. and fewer bugs, more-so a snapshot than a release since I have so much yet incomplete.
  14. I started on the official circapi client, this is more than a raw IRC client but still very raw
  15. in its current state. The only non-raw commands it accepts are COMMAND QUIT and COMMAND FORCEQUIT.
  16. I felt it prudent to upload my progress simply because the origional circapi release was buggy and
  17. was put together so quickly I feel it's hardly professional, comparing the origional release to this
  18. snapshot you can see what all I've done (and I have done a lot) however, this particular client
  19. does not yet support channel & user handling.
  20. The CIRCAPI client will be converted into a function called irc_client(). It will (in the dispatch
  21. process) call several virtual functions (pointers-to-functions) to make this API and client
  22. more modular for novice developers. This is the concept I have gone with since it seems most
  23. applicable to this sort of client.
  24. It will reside in a seperate object file and have its own header (so advanced developers can
  25. keep it out of there code when they don't need it).
  26. I have no excuse for my lack of progress, I've been enjoying life unplugged too much. Also
  27. working overtime (which is welcome right now!) and working on a load of side projects.
  28. Please e-mail me with questions, comments, critique and otherwise.
  29. dmolieri@users.sourceforge.net
  30. or visit my personal website and feel free to sign the guestbook!
  31. www.dustinsworld.net
  32. Thank you for your support and trying out my first developer-oriented personal GPL project to date.
  33. With the enjoyment I have gotten out of writing this project so far, I have a strong feeling I will
  34. persue others as well.
  35. Dustin Molieri,
  36. Senior Author, Unofficial C IRC API for Unix