diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..ebe3c4d --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# libtuberia + +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 + +You can ommit the source and sink, and inject or retrive elements from the pipelie + +## Building, Compiling, Installing + +If you don't have a ./configure file, run: +- `autoreconf -fi` + +When you have the ./configure file, run: +- `./configure` +- `make` +- `make install` + +You can see some configuration options with: +- `./configure --help` + +## Quick Guide + +### Quick example + |