aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMatt Singleton <matt@xcolour.net>2024-02-06 16:36:56 -0600
committerMatt Singleton <matt@xcolour.net>2024-02-06 16:36:56 -0600
commit2355d39b234705afc1e6a7d7fd36ead930f4fd47 (patch)
tree5043077445553db9b4cf58e985b57262ce5c5fcd /README.md
parentb8c3fd41000eff1774163661174806643873f1cf (diff)
update use instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 14 insertions, 3 deletions
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
+<meta name="viewport" content="width=device-width initial-scale=1.0"/>
```