From 2355d39b234705afc1e6a7d7fd36ead930f4fd47 Mon Sep 17 00:00:00 2001 From: Matt Singleton Date: Tue, 6 Feb 2024 16:36:56 -0600 Subject: update use instructions --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 4ea7a0b..ff86531 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,20 @@ changes for my own use. # How to use: -Beyond switching original CSS file with the one in this repository you should also add `head-include` line in your `cgitrc` file. -For example: +Place `cgit-main.css`, `cgit-responsive.css`, and `head.html` alongside your +existing `cgit.css` file. These responsive css rules are _additive_ to the +default `cgit.css`. + +Update your `cgitrc` to set the `css` and `head-include` directives. For example: + +``` +css=/cgit-main.css +head-include=/usr/share/cgit/head.html +``` + +If you already have a `head-include` set, just make sure to include the +appropriate viewport meta tag: ``` -head-include=/usr/share/webapps/cgit/head.html + ``` -- cgit v1.2.3