about summary refs log tree commit homepage
path: root/INSTALL
diff options
context:
space:
mode:
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL44
1 files changed, 44 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..80ff748
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,44 @@
+Dependencies: liburcu (Userspace RCU) is required at runtime.
+
+`pkg-config', GNU make, and standard Perl build tools are also required.
+
+             FreeBSD:        pkg install pkg-config liburcu
+Debian-based systems:        apt-get install pkg-config liburcu-dev
+
+
+Newer versions of xxhash can unlock a small bit of performance:
+
+        pkg install xxhash
+        apt-get install libxxhash-dev
+
+
+If using mwrap-rproxy, Plack is also required:
+
+        pkg install p5-Plack p5-Plack-Middleware-Deflater
+        apt-get install libplack-perl libplack-middleware-deflater-perl
+
+symlink-install
+---------------
+
+For users who lack permissions and/or wish to minimize their
+installation footprint, the "symlink-install" target is available.
+The following commands installs symlinks to $HOME/bin
+pointing to the source tree:
+
+        perl Makefile.PL
+        make symlink-install prefix=$HOME
+
+standard MakeMaker installation (Perl)
+--------------------------------------
+
+To use MakeMaker, you need to ensure ExtUtils::MakeMaker is available.
+This is typically installed with Perl, but RPM-based systems will likely
+need to install the `perl-ExtUtils-MakeMaker' package.
+
+Once the dependencies are installed, you should be able to build and
+install the system (into /usr/local) with:
+
+        perl Makefile.PL
+        make
+        make check
+        make install # root permissions may be needed