Code

rrtimeslice: Added hash function and operator class.
[postrr.git] / README
1 PostgreSQL Round-Robin Extension
2 ================================
4   PostRR (\ˈpōs-tər\) is an extension for the PostgreSQL database management
5   system providing round-robin functionality. It provides additional data
6   types and functions to handle discrete time-series of data and consolidation
7   thereof.
9   For now, the software is in an early and very experimental state.
11   This is free and open source software, licensed under the 2-clause BSD
12   license. See COPYING for details.
14 Prerequisites
15 -------------
17   To compile the PostRR package from source you need:
19   * A build environment: autotools, libtool, C compiler, ...
21   * A POSIX + Single UNIX Specification compatible C library.
23   * asciidoc, xsltproc:
24     The AsciiDoc text document format is used to write the manpages.
26   * PostgreSQL server-side development files
27     (currently tested with PostgreSQL 9.1)
29 Configuring / Compiling / Installing
30 ------------------------------------
32   To configure, build and install PostRR with the default settings, run
33   `./configure && make && make install'. For detailed, generic instructions
34   see INSTALL. For a complete list of configure options and their description,
35   run `./configure --help'.
37   By default, PostRR will be installed into `/opt/postrr'. You can adjust this
38   setting by specifying the `--prefix' configure option - see INSTALL for
39   details. If you pass DESTDIR=<path> to `make install', <path> will be
40   prefixed to all installation directories. This might be useful when creating
41   packages for PostRR.
43 Author
44 ------
46   Sebastian "tokkee" Harl <sh@tokkee.org>