Skip to content

Commit a8ab675

Browse files
ferrous26gitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 09b89d1 commit a8ab675

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

gitweb/INSTALL

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@ GIT web Interface (gitweb) Installation
33

44
First you have to generate gitweb.cgi from gitweb.perl using
55
"make gitweb/gitweb.cgi", then copy appropriate files (gitweb.cgi,
6-
gitweb.css, git-logo.png and git-favicon.png) to their destination.
7-
For example if git was (or is) installed with /usr prefix, you can do
6+
gitweb.js, gitweb.css, git-logo.png and git-favicon.png) to their
7+
destination. For example if git was (or is) installed with /usr prefix,
8+
you can do
89

910
$ make prefix=/usr gitweb/gitweb.cgi ;# as yourself
1011
# cp gitweb/git* /var/www/cgi-bin/ ;# as root
@@ -62,14 +63,15 @@ file for gitweb (in gitweb/README).
6263
a suggestion).
6364

6465
- You can control where gitweb tries to find its main CSS style file,
65-
its favicon and logo with the GITWEB_CSS, GITWEB_FAVICON and GITWEB_LOGO
66-
build configuration variables. By default gitweb tries to find them
67-
in the same directory as gitweb.cgi script.
66+
its JavaScript file, its favicon and logo with the GITWEB_CSS, GITWEB_JS
67+
GITWEB_FAVICON and GITWEB_LOGO build configuration variables. By default
68+
gitweb tries to find them in the same directory as gitweb.cgi script.
6869

69-
- You can optionally generate a minified version of gitweb.css by defining
70-
the CSSMIN build configuration variable. By default the non-minified
71-
version of gitweb.css will be used. NOTE: if you enable this option,
72-
substitute gitweb.min.css for all uses of gitweb.css in the help files.
70+
- You can optionally generate minified versions of gitweb.js and gitweb.css
71+
by defining the JSMIN and CSSMIN build configuration variables. By default
72+
the non-minified versions will be used. NOTE: if you enable this option,
73+
substitute gitweb.min.js and gitweb.min.css for all uses of gitweb.js and
74+
gitweb.css in the help files.
7375

7476
Build example
7577
~~~~~~~~~~~~~
@@ -79,13 +81,14 @@ Build example
7981
we want to display are under /home/local/scm, you can do
8082

8183
make GITWEB_PROJECTROOT="/home/local/scm" \
84+
GITWEB_JS="/gitweb/gitweb.js" \
8285
GITWEB_CSS="/gitweb/gitweb.css" \
8386
GITWEB_LOGO="/gitweb/git-logo.png" \
8487
GITWEB_FAVICON="/gitweb/git-favicon.png" \
8588
bindir=/usr/local/bin \
8689
gitweb/gitweb.cgi
8790

88-
cp -fv ~/git/gitweb/gitweb.{cgi,css} \
91+
cp -fv ~/git/gitweb/gitweb.{cgi,js,css} \
8992
~/git/gitweb/git-{favicon,logo}.png \
9093
/var/www/cgi-bin/gitweb/
9194

0 commit comments

Comments
 (0)