Ian Jauslin
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL27
1 files changed, 27 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..95955be
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,27 @@
+#######################################################################
+## ##
+## Installing BBlog ##
+## ##
+#######################################################################
+
+* BBlog is a bash script, and should work on any POSIX compliant
+ system, such as GNU/Linux or OSX.
+
+* Installing:
+ Run
+ make install
+
+ The default install prefix (/usr) can be changed by changing the
+ PREFIX variable.
+
+ The location in which the BBlog engines are installed can be changed
+ by changing the ENGINEDIR variable
+ (default '$(PREFIX)/share/BBlog/engines').
+ For example
+ make install PREFIX=/usr/local ENGINEDIR=/usr/local/BBlog/engines
+
+ When, for instance, building a package, the final location of the
+ engines directory might be different from that in which the engines
+ are to be installed. For such cases, use the ENGINEDIR_TARGET
+ variable to specify the final location of the engines directory
+ (default '$(ENGINEDIR)').