aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMiquel Lionel <lionel@les-miquelots.net>2021-06-17 22:41:39 +0100
committerMiquel Lionel <lionel@les-miquelots.net>2021-06-17 22:41:39 +0100
commit1fdb99eb4838a588d6fbcd949e7794360e5e5974 (patch)
treeac7f279eff0cdeecc8d0ef39537fbb6639c5aa12 /README.md
parent667f53a8480a1e122e4b92e88f7dc445ef4de716 (diff)
downloadhonk_custom-1fdb99eb4838a588d6fbcd949e7794360e5e5974.tar.gz
honk_custom-1fdb99eb4838a588d6fbcd949e7794360e5e5974.zip
moar on how to use
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 14 insertions, 7 deletions
diff --git a/README.md b/README.md
index d67add4..abe02b6 100644
--- a/README.md
+++ b/README.md
@@ -21,6 +21,16 @@ and patch the source with the rsstitle.patch.
The patches are useable outside the Makefile. You just have to make
sure to put them in the root of the cloned honk repo or untarred source.
+The `make rsstitle install` will :
+
+- apply the rsstitle patch
+- compile honk
+- copy manuals to the relevant sections in `/usr/share/man`
+- copy html template to `/usr/share/honk`
+- created the **honk** user and group if not existing
+- created a systemd service if `SYSTEMD=1` is defined in the Makefile
+- initialize the honk database if not existing at `/usr/share/honk/honk.db`
+
# Patches
## i18n.patch : Translation of the honk user interface
@@ -40,13 +50,13 @@ improvements.
Before the patch, the title and description of an user RSS Feed is like this:
-- title : yourhandle honk
-- description: yourhandle honk rss
+- **title** : yourhandle honk
+- **description**: yourhandle honk rss
After the patch:
-- title: @yourhandle - honking from honk.club
-- description: Honks from yourhandle@honk.club
+- **title**: @yourhandle - honking from honk.club
+- **description**: Honks from yourhandle@honk.club
I find it clearer.
@@ -66,7 +76,4 @@ The `altnavbar_i18n.patch` is the same, but the labels are i18n'd.
# Screenshots
-Alternative navigation bar, less uses of the menu on the left:
-[alt nav bar menu for honk](https://git.les-miquelots.net/honk_custom/plain/scrots/honk_altnavbar.png)
-
A video of the i18n module and the navbar patch [here](https://partage.les-miquelots.net/img/honk_i18n.mp4)