psyc-mirrors/libpsyc
1
0
Fork 0
mirror of git://git.psyc.eu/libpsyc synced 2024-08-15 03:19:02 +00:00
Code Issues Releases Wiki Activity

adde C API section to README

Browse source
This commit is contained in:
Marenz 2011-05-08 23:56:33 +02:00
parent ab8f70150e
commit 20b1408e43
1 changed files with 12 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README
View file

@ -10,9 +10,20 @@ 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 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. is primarily intended to be used for binding with other languages and frameworks.
Available bindings are located in include/<name> where name is the lanugage or Available bindings are located in include/<name> where name is the language or
framework. 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 == == Directory Overview ==