9:c9ffedb92be0
Anton Shestakov <av6@dwimlabs.net>, Fri, 07 Oct 2016 20:45:07 +0800
docs: update README and do it good

next change 23:c23d5f04caff
previous change 8:c370dd57b558

README.rst

Permissions: -rw-r--r--

Other formats: Feeds:
kit
---
A simple UIkit_-based theme for hgweb.
Compatibility
=============
This theme is designed to work with `Mercurial 3.9`_\+ (primarily because it
uses the new file annotate data).
Installation
============
The recommended way is to create 2 symlinks to templates/kit/ and
templates/static/style-kit.css in templates directory of your hgweb
installation in such way::
$ ls -l mercurial/templates/
...
gitweb
json
kit -> kit-repo/templates/kit/
kit-repo
monoblue
...
$ ls -l mercurial/templates/static/
...
style-gitweb.css
style-kit.css -> ../kit-repo/templates/static/style-kit.css
style-monoblue.css
...
(Since this theme doesn't bundle all the needed static files, you can't just do
web.templates = kit/templates/.)
After that, the theme can be selected as any other::
[web]
style = kit
License
=======
GNU GPLv2+, since it is technically based on gitweb, a theme bundled_ with
Mercurial.
Screenshot
==========
.. image:: https://bitbucket.org/av6/hgweb-kit-theme/raw/tip/screenshot.png
:width: 610px
.. _UIkit: https://getuikit.com/index.html
.. _Mercurial 3.9: https://www.mercurial-scm.org/wiki/Release3.9
.. _bundled: https://www.mercurial-scm.org/wiki/AvailableThemes#Bundled_with_Mercurial