# 
# 
# add_file "INSTALL"
#  content [75b63a12036505548443efb9376acc81c9880557]
# 
============================================================
--- INSTALL	75b63a12036505548443efb9376acc81c9880557
+++ INSTALL	75b63a12036505548443efb9376acc81c9880557
@@ -0,0 +1,97 @@
+
+Installing ViewMTN
+------------------
+
+This document briefly describes what is necessary to install ViewMTN 
+and configure a working installation.
+
+Dependencies
+------------
+
+ViewMTN should run on any Unix based operating system - MacOS,
+Linux, etc. It has not been ported to Windows, although that port
+should be possible.
+
+Python: http://www.python.org/
+A version >= 2.4 is required.
+
+Cheetah templates: http://www.cheetahtemplate.org/
+Version 0.9.16-1 from Debian is known to work.
+
+Optional
+--------
+
+Highlight: http://www.andre-simon.de/
+Version 2.4 is required for highlight work.
+Highlight is required if source code is to be shown highlighted.
+
+Shared Mime Info: http://freedesktop.org/wiki/Software/shared-mime-info
+Version 0.19 is known to work, although there is a specification
+so older versions should be fine. Most distributions provide this
+info.  Note that if you install this into a non-standard path,
+please export XDG_DATA_DIRS correctly (eg. XDG_DATA_DIRS=/opt/local/share)
+Without this package, ViewMTN will only perform extremely basic
+MIME type auto-detection.
+
+Icon Theme: http://www.freedesktop.org/software/icon-theme/
+Any version should be fine. If possible, use a distributor version
+of this package (Ubuntu is good!) as it will have a much richer
+selection of icons. See later in this file to find out how to
+configure ViewMTN to use icon themes.
+
+Configuring ViewMTN
+-------------------
+
+ViewMTN can run in standalone mode, or under a web server. It is
+recommended when first installing to ViewMTN to test it in standalone
+mode.
+
+If you have not already done so, copy "config.py.example" to
+"config.py". You will then need to edit "config.py" to suit your 
+site; there are numerous comments in the file, so this shouldn't be 
+too hard.
+
+You're then ready to run ViewMTN;
+	./viewmtn.py <port>
+If you leave off the <port> argument, ViewMTN will bind to port 8080.
+You can access ViewMTN by visiting:
+	http://localhost:8080/
+
+If everything has gone well, you should get the normal ViewMTN front
+page - a list of branches in the Monotone database you specified.
+If not, look at the output of viewmtn.py on the console; perhaps it 
+cannot read your monotone database, the path to 'mtn' is wrong, etc.
+
+Running ViewMTN in a web server
+-------------------------------
+
+ViewMTN is based upon web.py (http://webpy.org/); the installation
+instructions of webpy thus work for viewmtn. They are available 
+here:
+	http://webpy.infogami.com/install
+
+The following snippet of configuration is used to configure ViewMTN
+on http://viewmtn.angrygoats.net/ (running lighttpd) and is therefore
+known to work. You should be able to use it (with adjustment to
+suit your site).
+
+	fastcgi.server = ( "/viewmtn.py" =>
+	(( "socket" => "/var/tmp/lighttpd/viewmtn.socket",
+	   "bin-path" => "/home/grahame/mtn/viewmtn/viewmtn.py",
+	   "max-procs" => 8,
+	   "check-local" => "disable",
+	))
+	)
+
+	## a static document-root, for virtual-hosting take look at the 
+	## server.virtual-* options
+	$HTTP["host"] == "viewmtn.angrygoats.net" {
+		server.document-root       = "/home/grahame/mtn/viewmtn/"
+		dir-listing.activate = "enable"
+
+		url.rewrite-once = (
+		       "^/favicon.ico$" => "/static/favicon.ico",
+		       "^/static/(.*)$" => "/static/$1",
+		       "^/(.*)$" => "/viewmtn.py/$1",
+		)
+	}