X-Git-Url: https://git.m6w6.name/?p=m6w6%2Fgitweb-theme;a=blobdiff_plain;f=README.markdown;h=d9d3ceecaf9e42ab55a4035f8aa053596b03f1df;hp=1bf6f3a3a64c6e16f1f54e600edef181e14e9e1c;hb=20792560bb182f98e048d5dcfb769e4cd1770c1f;hpb=b56af9fee1e18b29b1f9d3d8a0a2b3a05fa4faa1 diff --git a/README.markdown b/README.markdown index 1bf6f3a..d9d3cee 100644 --- a/README.markdown +++ b/README.markdown @@ -10,12 +10,12 @@ The installation of this stylesheet is very easy: 1. Clone the repository to a location of your choice `git clone https://github.com/kogakure/gitweb-theme.git` 2. Run `./setup -vi --install` and your gitweb will be themed! - If you are on Ubuntu, then the script will default to gitweb's installation directory **/usr/share/gitweb/**. - - If this is not where gitweb is located, then pass the directory to the script with the --target or -t option. + - If this is not where gitweb is located, then pass the directory to the script with the `--target` or `-t` option. 3. Of course you can just copy them to the new location too. If you see some missing things or errors, please create a ticket or fix it and send a pull request. -### Configuration-File +### Configuration file *Did you know?* Updating Gitweb can be quite time consuming because you have to adjust your settings in the `gitweb.cgi`. **You don’t have to!**. @@ -35,14 +35,14 @@ $feature{'avatar'}{'default'} = ['gravatar']; $feature{'highlight'}{'default'} = [1]; ``` -### Syntax-Highlighting +### Syntax highlighting Optionally, you can enable syntax highlighting for your code. Install the highlight package with your package manager and add this line to /etc/gitweb.conf: ```perl $feature{'highlight'}{'default'} = [1]; ``` -### Gravatar-Support +### Gravatar support You can enable Gravatar support with this line: ```perl @@ -54,7 +54,14 @@ $feature{'avatar'}{'default'} = ['gravatar']; ### Categories -Gitweb supports categories, which can be enabled by adding a file to your Git-Repository: `.git/category`. In this file you write the name of the category. In the Gitweb interface they will get grouped by category. +Gitweb and this theme support categories, which can be enabled by the following gitweb config option: + +```perl +$projects_list_group_categories = true;¬ +``` + +The category name for each repository is read from `.git/category`, in the same manner as `.git/description`. + ## Setup Script