summaryrefslogtreecommitdiffstats
path: root/fbench/INSTALL
diff options
context:
space:
mode:
Diffstat (limited to 'fbench/INSTALL')
-rw-r--r--fbench/INSTALL35
1 files changed, 35 insertions, 0 deletions
diff --git a/fbench/INSTALL b/fbench/INSTALL
new file mode 100644
index 00000000000..2bbd9fb9fc2
--- /dev/null
+++ b/fbench/INSTALL
@@ -0,0 +1,35 @@
+******************
+* fbench INSTALL *
+******************
+
+fbench uses 'FastOS'. In the following instructions, let %FASTOS_DIR%
+denote the install directory for FastOS, also let %FBENCH_DIR% denote
+the install directory for fbench. A resonable selection of install
+directories would be:
+ %FASTOS_DIR% = '/usr/fastsearch/fastos'
+ %FBENCH_DIR% = '/usr/fastsearch/fbench'
+
+Install FastOS:
+- checkout the fastos CVS module
+- go to fastos/src/fastos
+- ./configure --install-dir %FASTOS_DIR% [<config parameters>]
+ (run ./configure --help for help)
+- make install
+
+Install fbench:
+- checkout the fbench CVS module
+- go to fbench/src
+- ./configure --fastos-dir %FASTOS_DIR% \
+ --install-dir %FBENCH_DIR% [<config parameters>]
+ (run ./configure --fastos-dir %FASTOS_DIR% --help for help)
+- make install
+
+This will install all needed binaries and scripts into
+%FBENCH_DIR%/bin. It will also copy the README file into
+%FBENCH_DIR%. The README file contains a step by step description of
+how to perform benchmarking.
+
+NOTE: When building on Win32, FastOS may have trouble resolving paths
+to directories that do not exist; If you want to use a relative path
+as install directory, Win32 users must create the install directory
+before running the configure script in the fbench directory.