summaryrefslogtreecommitdiff
path: root/gitweb
diff options
context:
space:
mode:
authorMark Rada <marada@uwaterloo.ca>2010-04-03 00:36:44 (GMT)
committerJunio C Hamano <gitster@pobox.com>2010-04-03 04:23:41 (GMT)
commita8ab675f21b6e8b003b7a8ba0a72933cf34afb68 (patch)
tree7f66af8ebc64ebb90aa9610d87c5d21f9b7cf941 /gitweb
parent09b89d1a082a298a182875076c068711210bb5c2 (diff)
downloadgit-a8ab675f21b6e8b003b7a8ba0a72933cf34afb68.zip
git-a8ab675f21b6e8b003b7a8ba0a72933cf34afb68.tar.gz
git-a8ab675f21b6e8b003b7a8ba0a72933cf34afb68.tar.bz2
gitweb: add documentation to INSTALL regarding gitweb.js
This patch updates gitweb/INSTALL to mention gitweb.js, including JavaScript minification support. Signed-off-by: Mark Rada <marada@uwaterloo.ca> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'gitweb')
-rw-r--r--gitweb/INSTALL23
1 files changed, 13 insertions, 10 deletions
diff --git a/gitweb/INSTALL b/gitweb/INSTALL
index b75a90b..44ff17d 100644
--- a/gitweb/INSTALL
+++ b/gitweb/INSTALL
@@ -3,8 +3,9 @@ GIT web Interface (gitweb) Installation
First you have to generate gitweb.cgi from gitweb.perl using
"make gitweb/gitweb.cgi", then copy appropriate files (gitweb.cgi,
-gitweb.css, git-logo.png and git-favicon.png) to their destination.
-For example if git was (or is) installed with /usr prefix, you can do
+gitweb.js, gitweb.css, git-logo.png and git-favicon.png) to their
+destination. For example if git was (or is) installed with /usr prefix,
+you can do
$ make prefix=/usr gitweb/gitweb.cgi ;# as yourself
# cp gitweb/git* /var/www/cgi-bin/ ;# as root
@@ -62,14 +63,15 @@ file for gitweb (in gitweb/README).
a suggestion).
- You can control where gitweb tries to find its main CSS style file,
- its favicon and logo with the GITWEB_CSS, GITWEB_FAVICON and GITWEB_LOGO
- build configuration variables. By default gitweb tries to find them
- in the same directory as gitweb.cgi script.
+ its JavaScript file, its favicon and logo with the GITWEB_CSS, GITWEB_JS
+ GITWEB_FAVICON and GITWEB_LOGO build configuration variables. By default
+ gitweb tries to find them in the same directory as gitweb.cgi script.
-- You can optionally generate a minified version of gitweb.css by defining
- the CSSMIN build configuration variable. By default the non-minified
- version of gitweb.css will be used. NOTE: if you enable this option,
- substitute gitweb.min.css for all uses of gitweb.css in the help files.
+- You can optionally generate minified versions of gitweb.js and gitweb.css
+ by defining the JSMIN and CSSMIN build configuration variables. By default
+ the non-minified versions will be used. NOTE: if you enable this option,
+ substitute gitweb.min.js and gitweb.min.css for all uses of gitweb.js and
+ gitweb.css in the help files.
Build example
~~~~~~~~~~~~~
@@ -79,13 +81,14 @@ Build example
we want to display are under /home/local/scm, you can do
make GITWEB_PROJECTROOT="/home/local/scm" \
+ GITWEB_JS="/gitweb/gitweb.js" \
GITWEB_CSS="/gitweb/gitweb.css" \
GITWEB_LOGO="/gitweb/git-logo.png" \
GITWEB_FAVICON="/gitweb/git-favicon.png" \
bindir=/usr/local/bin \
gitweb/gitweb.cgi
- cp -fv ~/git/gitweb/gitweb.{cgi,css} \
+ cp -fv ~/git/gitweb/gitweb.{cgi,js,css} \
~/git/gitweb/git-{favicon,logo}.png \
/var/www/cgi-bin/gitweb/