aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMiquel Lionel <lionelmiquel@sfr.fr>2021-01-25 18:54:46 +0100
committerMiquel Lionel <lionel@les-miquelots.net>2021-01-25 18:54:46 +0100
commit5c76508a26a2c9eb75a078e4afc548738aac5ea3 (patch)
treef2569e81351d290fb35af0b86fcb4017836986ed /README.md
parentd3a7e601a596509b0745412204872e558f7ad053 (diff)
downloadhonk_custom-5c76508a26a2c9eb75a078e4afc548738aac5ea3.tar.gz
honk_custom-5c76508a26a2c9eb75a078e4afc548738aac5ea3.zip
how to use section + screenshots in readme now
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index 9815cb4..dfeae21 100644
--- a/README.md
+++ b/README.md
@@ -5,3 +5,15 @@ Custom html page and templates or patches for the
ActivityPub server.
These are mainly related to the UX, but patching of the Go files
might happen if I feel the need.
+
+# How to use
+
+Clone or [download](https://git.les-miquelots.net/honk_custom/snapshot/honk_custom-master.zip)
+this repository and then copy the contents of the `views` directory on
+your honk `views` directory. For patches, I advice you to execute the
+following : `man patch`.
+
+# Screenshots
+
+Alternative navigation bar, less uses of the drop down menu:
+[alt nav bar menu for honk](https://git.les-miquelots.net/honk_custom/plain/scrots/honk_altnavbar.png)