Added documentation for Gravatar support
[m6w6/gitweb-theme] / README.rst
index 5da55484dd432c5ac839a5f3328fa6e0ca1234b7..efff7a5e2d7332d74db17b0b872b9e257e7b5673 100644 (file)
@@ -2,7 +2,7 @@
 Theme for gitweb
 ================
 
-This is an alternative theme for `gitweb`_ (tested with git web interface version 1.7.12). It is *strongly* inspired by GitHub.
+This is an alternative theme for `gitweb`_ (tested with git web interface version 1.7.12.3). It is *strongly* inspired by GitHub.
 
 Fullsize screenshots available on `kogakure.github.com/gitweb-theme`_.
 
@@ -26,6 +26,14 @@ Just clone the repository to a location of your choice, probably into the same d
 
 Of course you can just copy them to the new location. If you see some missing things or errors, please create a ticket or fix it and send a pull request.
 
+Optionally, you can enable syntax highlighting for your code. Install the highligh package with your package manager and add this line to /etc/gitweb.conf:
+
+  $feature{'highlight'}{'default'} = [1];
+
+You can enable Gravatar support with this line:
+
+  $feature{'avatar'}{'default'} = ['gravatar'];
+
 .. _gitweb: http://git.or.cz/gitwiki/Gitweb
 .. _kogakure.github.com/gitweb-theme: http://kogakure.github.com/gitweb-theme