2011-05-08 20:33:21 +00:00
|
|
|
= libpsyc README file =
|
2011-05-08 20:20:01 +00:00
|
|
|
|
2011-05-08 20:33:21 +00:00
|
|
|
libpsyc implements various functions required to use PSYC.
|
2011-05-08 20:31:54 +00:00
|
|
|
|
|
|
|
|
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.
|
2011-05-08 20:20:01 +00:00
|
|
|
|
|
|
|
|
The plain C API located in the include/psyc directory along with the file psyc.h
|
2011-05-08 20:31:54 +00:00
|
|
|
is primarily intended to be used for binding with other languages and frameworks.
|
2011-05-08 20:20:01 +00:00
|
|
|
|
2011-05-08 21:56:33 +00:00
|
|
|
Available bindings are located in include/<name> where name is the language or
|
2011-05-08 20:20:01 +00:00
|
|
|
framework.
|
|
|
|
|
|
2011-05-08 21:56:33 +00:00
|
|
|
== 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:
|
|
|
|
|
|
2011-05-09 07:02:15 +00:00
|
|
|
psyc.h -- basic things for well-being
|
|
|
|
|
psyc/parse.h -- parse psyc packets
|
|
|
|
|
psyc/render.h -- render psyc packets
|
|
|
|
|
psyc/text.h -- text template functions
|
|
|
|
|
psyc/packet.h -- structures for render.h and functions to initialize them
|
|
|
|
|
psyc/syntax.h -- definitions and constants related to parsing and rendering
|
2011-05-08 20:20:01 +00:00
|
|
|
|
|
|
|
|
== Directory Overview ==
|
|
|
|
|
|
2011-05-08 20:31:54 +00:00
|
|
|
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
|
2011-05-08 20:20:01 +00:00
|
|
|
|
|
|
|
|
== Compiling libpsyc ==
|
|
|
|
|
|
|
|
|
|
Type
|
|
|
|
|
|
|
|
|
|
make
|
|
|
|
|
|
|
|
|
|
and you are done.
|
|
|
|
|
Other possible targets include:
|
|
|
|
|
|
2011-05-08 20:31:54 +00:00
|
|
|
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.
|
2011-05-08 20:20:01 +00:00
|
|
|
|
|
|
|
|
== Contributors And Contribution ==
|
|
|
|
|
|
|
|
|
|
The library is being developed by
|
|
|
|
|
|
2011-05-08 20:31:54 +00:00
|
|
|
* tg -- psyc://psyced.org/~tg
|
|
|
|
|
* lynx -- psyc://psyced.org/~lynx
|
|
|
|
|
* Marenz -- psyc://supraverse.net/~marenz
|
2011-05-08 20:20:01 +00:00
|
|
|
|
|
|
|
|
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 ==
|
|
|
|
|
|
2011-05-08 20:31:54 +00:00
|
|
|
-- To be discussed --
|
2011-05-09 07:02:15 +00:00
|
|
|
|
|
|
|
|
== Style Wars ==
|
|
|
|
|
|
|
|
|
|
This source code should follow the http://about.psyc.eu/Indent conventions.
|
|
|
|
|
(if you have good reasons to use another style, discuss it on the
|
|
|
|
|
wiki page so that it becomes the general style convention for all
|
|
|
|
|
of us, not just for you).
|
|
|
|
|
|
