diff options
| author | Nicolas Dato <nicolas.dato@gmail.com> | 2025-07-17 20:52:49 -0300 |
|---|---|---|
| committer | Nicolas Dato <nicolas.dato@gmail.com> | 2025-07-18 07:15:02 -0300 |
| commit | b1fcc672448f8403a567cd280c2151eb6d5799cb (patch) | |
| tree | 995ef80358f3c88807d8034b5ad3f78b54301482 /README.md | |
| parent | ee208b6f61a4f2f52d6a796acdb0764374d23234 (diff) | |
| download | libtuberia-b1fcc672448f8403a567cd280c2151eb6d5799cb.tar.gz | |
adding documentation
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 + |