commit 54ca09ad7b8318876321436c780305f895b38163
parent 883d69347cfcbfd16870e468fc815abf6851e5d4
Author: Jeff <dev@watertao.xyz>
Date:   Sat, 10 May 2025 18:38:24 -0700

README updated with md markdown for html page

Diffstat:
M
README
 | 
32
++++++++++++++++++--------------

1 file changed, 18 insertions(+), 14 deletions(-)
diff --git a/README b/README
@@ -5,14 +5,15 @@ mpd history html
 
 Usage
 -----
-mpdhh.sh 0 > Update data & site
-mpdhh.sh 1 > stdout current track
-mpdhh.sh 2 > update historia only
-mpdhh.sh 3 > update analysis only
-mpdhh.sh 4 > initiate directory tree
+    mpdhh.sh 0 > Update data & site
+    mpdhh.sh 1 > stdout current track
+    mpdhh.sh 2 > update historia only
+    mpdhh.sh 3 > update analysis only
+    mpdhh.sh 4 > initiate directory tree
+
 
 Disable site updates:
-export MPDHH_PUBLISH="n" mpdhh.sh
+    export MPDHH_PUBLISH="n" mpdhh.sh
 
 
 Description
@@ -51,10 +52,10 @@ happily on musl Void in a rather suckless environment.
 
 Requirements
 ------------
-mpd
-mpc
-posix compliant shell tools: awk/sed/grep/sort
-hugo or full html markup needed
+- mpd
+- mpc
+- posix compliant shell tools: awk/sed/grep/sort
+- hugo or full html markup needed
 
 
 
@@ -66,13 +67,14 @@ for and runs a 'publish.sh' file in the project dir. It is in this file
 one runs all the cms commands to update a website. A simple one-liner
 gets it done for a git managed hugo setup:
 
-hugo && git add . && git commit && git push
+    hugo && git add . && git commit && git push
 
 This program assumes the following tree:
 (run mpdhh.sh 4 to create the tree)
 
+```
 project/
-----content/
+---- content/
 -------- music/
 ------------ _index.[html|md]
 ------------ analysis/
@@ -90,12 +92,14 @@ project/
 ---------------- db.index
 ---------------- [date_bin]/
 -------------------- _index.[html|md]
+```
 
-Important hugo note;
+Important hugo note:
 In light of mpdhh independence from hugo, the following menu bit needs
 to be injected into the project's hugo config file (e.g. hugo.yaml) for
 the usage of "Analysis" menus:
 
+```
 menus:
  analysis:
    - name: Artists
@@ -114,4 +118,4 @@ menus:
      pageRef: /music/analysis/tracks/by-track
    - name: Play Count
      pageRef: /music/analysis/tracks/by-play-count
-
+```