Download:
child 9:c9ffedb92be0
parent 7:7850c313104e
8:c370dd57b558
Anton Shestakov <av6@dwimlabs.net>, Fri, 07 Oct 2016 19:08:09 +0800
docs: add a README

1 файлов изменено, 58 вставок(+), 0 удалений(-) [+]
README.rst file | annotate | diff | comparison | revisions
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/README.rst Fri Oct 07 19:08:09 2016 +0800
@@ -0,0 +1,58 @@
+.. image:: https://bitbucket.org/av6/hgweb-kit-theme/raw/tip/screenshot.png
+
+
+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.
+
+
+.. _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