gitweb: use out-of-line GIT logo.
[gitweb.git] / gitweb / README
index 3014d7320bcc5412447070c5a5eacf0d25317eb8..1b2180c7314ea3d10db78c88b48092a70491f8b8 100644 (file)
@@ -3,14 +3,26 @@ GIT web Interface
 The one working on:
   http://www.kernel.org/git/
 
-Get the gitweb.cgi by ftp:
-  ftp://ftp.kernel.org/pub/software/scm/gitweb/
+From the git version 1.4.0 gitweb is bundled with git.
 
-It reqires the git-core binaries installed on the system:
-  http://www.kernel.org/git/?p=git/git.git;a=summary
 
-The gitweb repository is here:
-  http://www.kernel.org/git/?p=git/gitweb.git;a=summary
+How to configure gitweb for your local system:
+
+You can specify the following configuration variables when building GIT:
+ * GITWEB_SITENAME
+   Shown in the title of all generated pages, defaults to the servers name.
+ * GITWEB_PROJECTROOT
+   The root directory for all projects shown by gitweb.
+ * GITWEB_LIST
+   points to a directory to scan for projects (defaults to project root)
+   or to a file for explicit listing of projects.
+ * GITWEB_HOMETEXT
+   points to an .html file which is included on the gitweb project
+   overview page.
+ * GITWEB_CSS
+   Points to the location where you put gitweb.css on your web server.
+ * GITWEB_LOGO
+   Points to the location where you put git-logo.png on your web server.
 
 Any comment/question/concern to:
   Kay Sievers <kay.sievers@vrfy.org>