diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 22 |
1 files changed, 16 insertions, 6 deletions
@@ -24,17 +24,19 @@ SOFTWARE. ## About -libtuberia: a library to implement a pipeline +libtuberia: a library to implement a pipeline. A pipeline would be: *[Source] -> [queue_1] -> [Stage_1] -> [Queue_2] -> [Stage_2] -> [...] -> [Sink]* -Each source, stage, and sink runs in a thread, reads from its imput queue and -write to the output queue +Each source, stage, and sink runs in a thread, reads from its input queue, +process the element, and writes the result to the output queue. -You can omit the source and sink, and inject or retrieve elements from the -pipeline +This project is available: +* At my personal website: <https://ndato.com/projects/libtuberia/> +* At Savannah: <https://savannah.nongnu.org/projects/libtuberia/> +You can submit bugs at Savannah. ## Building, Compiling, Installing @@ -58,7 +60,15 @@ Include tuberia.h, and link libtuberia.a and pthread: `-ltuberia -lpthread` You can also use: `pkg-config --cflags --libs --static tuberia` -## Quick Guide +## Documentation + +The `src/tuberia.h` file has every structure and function documented. + +And if you had [Doxygen](https://www.doxygen.nl) when installing libtuberia, a +man page `tuberia.h` is also installed (you can read it with `man tuberia.h`) +and a .html is installed in `/usr/doc/libtuberia/doxygen_html/index.html`. + +### Quick Guide See the files `example/simple.c` and `example/decode_resize_encode.c` (function `do_tuberia()` in particular) |