summaryrefslogtreecommitdiff
path: root/gitweb/static/js/README
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2011-05-26 10:31:57 -0700
committerJunio C Hamano <gitster@pobox.com>2011-05-26 10:31:57 -0700
commita6f3f178bd7ce48f7fe4262a1e5efb3ae6a98a4d (patch)
treefa4658c6142b1561cc2459874968de5087ae8185 /gitweb/static/js/README
parent229e72dd6a34a2fbe5998fbddde44cb00174a602 (diff)
parent2e987f92408f5ddd20246d7d9553b57d90767d54 (diff)
downloadgit-a6f3f178bd7ce48f7fe4262a1e5efb3ae6a98a4d.tar.gz
Merge branch 'jn/gitweb-js'
* jn/gitweb-js: gitweb: Make JavaScript ability to adjust timezones configurable gitweb.js: Add UI for selecting common timezone to display dates gitweb: JavaScript ability to adjust time based on timezone gitweb: Unify the way long timestamp is displayed gitweb: Refactor generating of long dates into format_timestamp_html gitweb.js: Provide getElementsByClassName method (if it not exists) gitweb.js: Introduce code to handle cookies from JavaScript gitweb.js: Extract and improve datetime handling gitweb.js: Provide default values for padding in padLeftStr and padLeft gitweb.js: Update and improve comments in JavaScript files gitweb: Split JavaScript for maintability, combining on build
Diffstat (limited to 'gitweb/static/js/README')
-rw-r--r--gitweb/static/js/README20
1 files changed, 20 insertions, 0 deletions
diff --git a/gitweb/static/js/README b/gitweb/static/js/README
new file mode 100644
index 0000000000..f8460ed32f
--- /dev/null
+++ b/gitweb/static/js/README
@@ -0,0 +1,20 @@
+GIT web interface (gitweb) - JavaScript
+=======================================
+
+This directory holds JavaScript code used by gitweb (GIT web interface).
+Scripts from there would be concatenated together in the order specified
+by gitweb/Makefile into gitweb/static/gitweb.js, during building of
+gitweb/gitweb.cgi (during gitweb building). The resulting file (or its
+minification) would then be installed / deployed together with gitweb.
+
+Scripts in 'lib/' subdirectory compose generic JavaScript library,
+providing features required by gitweb but in no way limited to gitweb
+only. In the future those scripts could be replaced by some JavaScript
+library / framework, like e.g. jQuery, YUI, Prototype, MooTools, Dojo,
+ExtJS, Script.aculo.us or SproutCore.
+
+All scripts that manipulate gitweb output should be put outside 'lib/',
+directly in this directory ('gitweb/static/js/'). Those scripts would
+have to be rewritten if gitweb moves to using some JavaScript library.
+
+See also comments in gitweb/Makefile.