1
0
Fork 0
mirror of git://git.psyc.eu/libpsyc synced 2024-08-15 03:19:02 +00:00
libpsyc source code from git://git.psyc.eu/libpsyc
Find a file
2011-05-09 02:29:07 +02:00
d make install 2011-05-09 02:27:12 +02:00
doc doc style fix 2011-04-27 00:17:19 +02:00
include Merge branch 'master' of supraverse.net:libpsyc 2011-05-09 02:29:07 +02:00
lib make install 2011-05-09 02:27:12 +02:00
src parser: cleaned up psycParseRC 2011-05-09 01:47:06 +02:00
test moved debug.h lib.h to src 2011-05-08 23:40:26 +02:00
.gitignore make install 2011-05-09 02:27:12 +02:00
Doxyfile make install 2011-05-09 02:27:12 +02:00
Makefile make install 2011-05-09 02:27:12 +02:00
README adde C API section to README 2011-05-08 23:56:33 +02:00

= libpsyc README file =

libpsyc implements various functions required to use PSYC. 

See http://about.psyc.eu/libpsyc for more information on the library.
See http://about.psyc.eu/Specification for more information
    on the new PSYC specification.
See http://about.psyc.eu for information on PSYC in general.

The plain C API located in the include/psyc directory along with the file psyc.h
is primarily intended to be used for binding with other languages and frameworks.

Available bindings are located in include/<name> where name is the language or
framework.

== C API ==

The "plain C API" is a very low-level API intended to be used for bindings.
To access a certain module of the library, just include the according header
file from the psyc directory:

parser.h -- parse psyc packets
render.h -- render psyc packets
text.h   -- text template functions 
packet.h -- structures for render.h and functions to initialize them
syntax.h -- definitions and constants related to parsing and rendering

== Directory Overview ==

doc     -- where the documentation will be put after generation
include -- contains all bindings and the core C API for the library
lib     -- where the compiled library will be put
src     -- contains the sourcecode of the library
test    -- contains test sourcecodes and test input files

== Compiling libpsyc ==

Type 

  make

and you are done.
Other possible targets include:

  make diet   -- compile with diet libc
  make test   -- compile and run the test
  make doc    -- generate the API documentation (will be put in the doc folder)
  make help   -- display the possible targets

== Requirements ==

libpsyc is currently known to compile under Linux and SunOS.

== Contributors And Contribution ==

The library is being developed by 

* tg     -- psyc://psyced.org/~tg 
* lynx   -- psyc://psyced.org/~lynx
* Marenz -- psyc://supraverse.net/~marenz

If you created new bindings, patches or anything other that you think should go
into the library, contact either anyone of us directly or just join the
developement room at 

   psyc://psyced.org/@welcome
   xmpp:*welcome@psyced.org  (jabber is known to have problems sometimes)
   irc://psyced.org/welcome

== Licence ==

-- To be discussed --