mirror of
git://git.psyc.eu/libpsyc
synced 2024-08-15 03:19:02 +00:00
updated README
This commit is contained in:
parent
917ef4cff2
commit
972f076dc8
1 changed files with 9 additions and 8 deletions
17
README
17
README
|
@ -10,8 +10,8 @@ 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 language or
|
Available bindings are located directly in the root folder named according to
|
||||||
framework.
|
the language or framework. Currently there exists only a binding for D
|
||||||
|
|
||||||
== C API ==
|
== C API ==
|
||||||
|
|
||||||
|
@ -28,11 +28,12 @@ psyc/syntax.h -- definitions and constants related to parsing and rendering
|
||||||
|
|
||||||
== Directory Overview ==
|
== Directory Overview ==
|
||||||
|
|
||||||
doc -- where the documentation will be put after generation
|
doc -- target folder for the documentation after generation (make doc)
|
||||||
include -- contains all bindings and the core C API for the library
|
include -- the core C API for the library
|
||||||
lib -- where the compiled library will be put
|
lib -- target folder for the compiled library (make)
|
||||||
src -- contains the sourcecode of the library
|
src -- the sourcecode of the library
|
||||||
test -- contains test sourcecodes and test input files
|
test -- test sourcecodes and test input files
|
||||||
|
d -- the D binding
|
||||||
|
|
||||||
== Compiling libpsyc ==
|
== Compiling libpsyc ==
|
||||||
|
|
||||||
|
@ -65,7 +66,7 @@ into the library, contact either anyone of us directly or just join the
|
||||||
developement room at
|
developement room at
|
||||||
|
|
||||||
psyc://psyced.org/@welcome
|
psyc://psyced.org/@welcome
|
||||||
xmpp:*welcome@psyced.org (jabber is known to have problems sometimes)
|
xmpp:*welcome@psyced.org (gtalk probably won't work)
|
||||||
irc://psyced.org/welcome
|
irc://psyced.org/welcome
|
||||||
|
|
||||||
== Licence ==
|
== Licence ==
|
||||||
|
|
Loading…
Reference in a new issue