diff options
author | Yorhel <git@yorhel.nl> | 2013-04-04 09:37:58 +0200 |
---|---|---|
committer | Yorhel <git@yorhel.nl> | 2013-04-04 09:52:07 +0200 |
commit | 8957f920eceb992f5ddbe6c18344560166b78805 (patch) | |
tree | 2767b0ff90df67e2dc90f7b05315cf3fd942b185 | |
parent | b3bf03acd0081c9262c6c78cb31537e9acac8826 (diff) |
Use POD for the README
So that I can put this stuff on my website. The new home of ylib is now:
http://dev.yorhel.nl/ylib
-rw-r--r-- | README | 45 | ||||
-rw-r--r-- | README.pod | 75 |
2 files changed, 75 insertions, 45 deletions
@@ -1,45 +0,0 @@ -This git repository holds a collection of small and independent C libraries. - - dbusev - Register a DBusConnection with libev - dbusuv - Register a DBusConnection with libuv - ecbuf - An expanding circular buffer - evtp - A convenient thread pool for libev - ylog - A logging system - yopt - A portable getopt_long() replacement - yuri - A minimal URI validation and parsing library - -Documentation for each library can be found in the .h files. To use a library, -simply copy the .h and .c file (if any) into your project. All of the above -libraries are written with the goal of being small, efficient and portable. - -In this context, 'small' refers to the code size -- it is easier to understand -and integrate a small library than it is to use a larger one. - -'Efficient' refers to having a low memory and computational overhead, where -that makes sense. That usually manifests itself in avoiding excessive use of -dynamic memory (malloc()/realloc()/free()) and system calls. - -My idea of 'portable' is somewhat along the lines of "it should work on any 5+ -years old UNIX-like system". In practice this may not always be true due to the -lack of rigorous testing, but I very much appreciate patches that help reach -this goal. Note that I do not consider native Windows/MSVC part of this -equation. Some libraries may work on Windows, others certainly won't. -Similarly, these are all C libraries, a C++ compiler may not necessarily like -them. Patches to improve Windows or C++ support are welcome, as long as the -modifications are not very involved. - -This repository likely won't have everything you need. Here are a few other -excellent libraries and library collections: - - Klib https://github.com/attractivechaos/klib - CCAN http://ccodearchive.net/ - libev http://software.schmorp.de/pkg/libev.html - Juliusz' threadpool https://github.com/jech/threadpool - -...but there are no doubt many more that I am not aware of. - -I appreciate feedback of any kind, feel free to contact me at: - - Email: projects@yorhel.nl - DC: Yorhel @ adc://dc.blicky.net:2780/ - IRC: Yorhel @ SynIRC or Freenode diff --git a/README.pod b/README.pod new file mode 100644 index 0000000..0eda1d5 --- /dev/null +++ b/README.pod @@ -0,0 +1,75 @@ +=pod + +Ylib is a collection of small and mostly independent C libraries. + +=head2 Libraries + +=over + +=item B<dbusev> (L<dbusev.h|http://g.blicky.net/ylib.git/plain/dbusev.h> and L<dbusev.c|http://g.blicky.net/ylib.git/plain/dbusev.c>) + +Register a DBusConnection (libdbus-1) with libev. + +=item B<ecbuf> (L<ecbuf.h|http://g.blicky.net/ylib.git/plain/ecbuf.h>) + +An automatically expanding type-safe generic circular buffer. + +=item B<evtp> (L<evtp.h|http://g.blicky.net/ylib.git/plain/evtp.h> and L<evtp.c|http://g.blicky.net/ylib.git/plain/evtp.c>) + +A convenient thread pool for libev based on the L<threadpool library|https://github.com/jech/threadpool> by Juliusz Chroboczek. + +=item B<ylog> (L<ylog.h|http://g.blicky.net/ylib.git/plain/ylog.h> and L<ylog.c|http://g.blicky.net/ylib.git/plain/ylog.c>) + +A low-level logging system for C. + +=item B<yopt> (L<yopt.h|http://g.blicky.net/ylib.git/plain/yopt.h>) + +A portable and minimal C<getopt_long()> replacement. + +=item B<yuri> (L<yuri.h|http://g.blicky.net/ylib.git/plain/yuri.h> and L<yuri.c|http://g.blicky.net/ylib.git/plain/yuri.c>) + +A minimal URI validation and parsing library. + +=back + +Documentation for each library can be found in the .h files. To use a library, +simply copy the .h and .c file (if any) into your project. + +=head2 Overview + +All of these libraries are written with the goal of being small, efficient and +portable. + +In this context, 'small' refers to the code size -- it is easier to understand +and integrate a small library than it is to use a larger one. + +'Efficient' refers to having a low memory and computational overhead, where +that makes sense. That usually manifests itself in avoiding excessive use of +dynamic memory (malloc()/realloc()/free()) and system calls. + +My idea of 'portable' is somewhat along the lines of "it should work on any 5+ +years old UNIX-like system". In practice this may not always be true due to the +lack of rigorous testing, but I very much appreciate patches that help reach +this goal. Note that I do not consider native Windows/MSVC part of this +equation. Some libraries may work on Windows, others certainly won't. +Similarly, these are all C libraries, a C++ compiler may not necessarily like +them. Patches to improve Windows or C++ support are welcome, as long as the +modifications are not very involved. + +=head2 Relevant links + +Ylib likely won't have everything you need. Here are a few other excellent +libraries and library collections. This list is definitely not complete, feel +free to contact me if you have more relevant projects to be listed here. + +=over + +=item * L<Klib|https://github.com/attractivechaos/klib> - Generic and efficient data structures. + +=item * L<CCAN|http://ccodearchive.net/> - Comprehensive C Archive Network. Need I say more? :) + +=item * L<libev|http://software.schmorp.de/pkg/libev.html> - An excellent high-performance event loop. + +=item * L<Juliusz' threadpool|https://github.com/jech/threadpool> - A simple thread pool. + +=back |