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

+

Browse source
This commit is contained in:
psyc://psyced.org/~lynX 2011-05-08 22:31:54 +02:00
parent ae3fc4c75a
commit 87bdf3aae4
1 changed files with 23 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
README
View file

@ -1,13 +1,14 @@
= libpsyc Readme File = = libpsyc Readme File =
libpsyc implements various functions required to use psyc. 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 See http://about.psyc.eu/libpsyc for more information on the library.
specification See http://about.psyc.eu/Specification for more information
See http://about.psyc.eu for information on psyc in general. 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 The plain C API located in the include/psyc directory along with the file psyc.h
is primary 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 lanugage or
framework. framework.
@ -15,11 +16,11 @@ framework.
== Directory Overview == == Directory Overview ==
doc — where the documentation will be put after generation doc -- where the documentation will be put after generation
include — contains all bindings and the core C API for the library include -- contains all bindings and the core C API for the library
lib — where the compiled library will be put lib -- where the compiled library will be put
src — contains the sourcecode of the library src -- contains the sourcecode of the library
test — contains test sourcecodes and test input files test -- contains test sourcecodes and test input files
== Compiling libpsyc == == Compiling libpsyc ==
@ -30,22 +31,26 @@ Type
and you are done. and you are done.
Other possible targets include: Other possible targets include:
make diet — compile with diet libc make diet -- compile with diet libc
make test — compile and run the test make test -- compile and run the test
make doc — generate the API documentation (will be put in the doc folder) make doc -- generate the API documentation (will be put in the doc folder)
make help — display the possible targets make help -- display the possible targets
== Requirements ==
libpsyc is currently known to compile under Linux and SunOS.
== Contributors And Contribution == == Contributors And Contribution ==
The library is being developed by The library is being developed by
* tg — psyc://psyced.org/~tg * tg -- psyc://psyced.org/~tg
xmpp:tg@psyced.org xmpp:tg@psyced.org
irc://psyced.org/~tg irc://psyced.org/~tg
* lynx — psyc://psyced.org/~lynx * lynx -- psyc://psyced.org/~lynx
xmpp:lynx@psyced.org xmpp:lynx@psyced.org
irc://psyced.org/~lynX irc://psyced.org/~lynX
* Marenz — psyc://supraverse.net/~marenz * Marenz -- psyc://supraverse.net/~marenz
xmpp:marenz@supraverse.net xmpp:marenz@supraverse.net
irc://supraverse.net/~marenz irc://supraverse.net/~marenz
@ -59,4 +64,4 @@ developement room at
== Licence == == Licence ==
— To be discussed — -- To be discussed --