Extended the installation description
authorMario Rimann <mario@rimann.org>
Thu, 5 Jul 2012 10:43:22 +0000 (12:43 +0200)
committerMario Rimann <mario@rimann.org>
Thu, 5 Jul 2012 10:43:22 +0000 (12:43 +0200)
Now explaining how to move away the existing files and instead
using symlinks to the checked out clone of the theme.

README.rst

index 7597e9957440b8123a42f787aa0fb2203e6ffa38..50415b6a30f4689d6cdb5bb7796d57dcb1acc164 100644 (file)
@@ -9,10 +9,16 @@ Fullsize screenshots available on `kogakure.github.com/gitweb-theme`_.
 Installation
 ============
 
-The installation of this stylesheet is very easy
+The installation of this stylesheet is very easy:
 
-Just copy the CSS-file `gitweb.css` into the gitweb folder. Best practise
-would be to rename the old file, in case you want to switch back.
+Just clone the repository to a location of your choice, probably into the same directory where the base gitweb stylesheet is located (in Ubuntu, this is e.g. /usr/share/gitweb/). It's recommended to move away the existing files and then create symlinks to the new files. You can do this with the following few commands::
+
+       cd <PUT YOUR LOCATION OF GITWEB HERE, could be /usr/share/gitweb/>
+       mv gitweb.css gitweb_original.css
+       mv gitweb.js gitweb_original.js
+       git clone git://github.com/kogakure/gitweb-theme.git
+       ln -s gitweb-theme/gitweb.css gitweb.css
+       ln -s gitweb-theme/gitweb.js gitweb.js
 
 If you see some missing things or errors, please post a comment.