development/git
development/git
1
0
Fork 0
mirror of https://github.com/git/git synced 2024-08-27 11:39:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

gitweb: add documentation to INSTALL regarding gitweb.js

Browse source 
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>
This commit is contained in:
Mark Rada 2010-04-02 20:36:44 -04:00 committed by Junio C Hamano
parent 09b89d1a08
commit a8ab675f21
1 changed files with 13 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
gitweb/INSTALL
View file

@ -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/