From ca58a0e31bc8bf7e795b9225b78c31788ae22f13 Mon Sep 17 00:00:00 2001
From: zi <z@pad.ma>
Date: Wed, 7 Aug 2024 18:25:40 +0530
Subject: [PATCH] clean readme

---
 README.md | 74 ++++++++++++++++++++++++++++++++-----------------------
 1 file changed, 43 insertions(+), 31 deletions(-)

diff --git a/README.md b/README.md
index 71f0f2b..974ce0b 100644
--- a/README.md
+++ b/README.md
@@ -1,41 +1,50 @@
 
 Play LED light sequences from csv. Control LED lights using PyDMXControl
 
-Install... 
+Install: 
 https://github.com/MattIPv4/PyDMXControl/tree/master
 
 
 Calc fields / Variables:
-# seq -> "sequence" = position (seconds) on 'timeline' starting 0
-# fadein / fadeout (milliseconds) [optional/default]
-# duration (seconds) 
-# brightness -> 0-255 (optional, else default) [optional/default]
-# "channel" --> LED/channel identifier, order as connected to DMX decoder
+- seq -> "sequence" = position (seconds) on 'timeline' starting 0
+- fadein / fadeout (milliseconds) [optional/default]
+- duration (seconds) 
+- brightness -> 0-255 (optional, else default) [optional/default]
+- "channel" --> LED/channel identifier, order as connected to DMX decoder
 (channel = name | opendmxcontroller calls fixtures "by_name")
 - channels are sequential and fixed
 - blank channels also must be added to dmx..()
 
-## Map channels:
-(play one at a time, wait for input)
-$ python3 mapchannels.py
+- Map channels (play one at a time, wait for input):    
+```
+ $ python3 mapchannels.py
+```
 
-# run sequence:
-- $ python3 sequence.py
+- run sequence:
+```
+ $ python3 sequence.py
+```
 
-# run sequence from START cell (not from t=0):
-- $ python3 zztest_sequence.py
+- run sequence from START cell (not from t=0):
+```
+ $ python3 zztest_sequence.py
+```
 
-## debug: 
-(play single channel only and exit)
-$ python3 playsingle.py <channel/name>
+- debug: 
+  - (play single channel only and exit)
+```
+ $ python3 playsingle.py <channel/name>
+```
 
 _____
 
 *** EDIT ("seq", "duration", optional "brightness") and play sequence: 
 
 - edit local or online calc/csv 
-# get csv -> sequence.json
-- $ python3 getspread.py  
+- get csv -> sequence.json
+```
+ $ python3 getspread.py  
+```
 
 - restart service
 
@@ -43,36 +52,39 @@ _____
 
 _____
 
-# check script output:
-$ tmux a
-or
+- check script output:
+```
 $ tmux a -t light 
+```
 
 ---
 
-lights.service runs sequence.py in a tmux session called "light"
-
-(Run outside tmux)
-
-# start/stop/restart service now 
+lights.service runs sequence.py in a tmux session called "light"   
+(Run outside tmux)   
+[ start/stop/restart service now ]
+```
 sudo systemctl <start/stop/restart> lights.service
+```
 
-# enable/disable service on boot
+enable/disable service on boot
+```
 sudo systemctl <enable/disable> lights.service
+```
 
-# check status
+check status
+```
 systemctl status lights.service  
-
+```
 ---
 
 *dev* service script: 
 
-xetc_systemd_system -> lights.service
+xetc_systemd_system -> lights.service  
 edit here if required, and copy to /etc/systemd/system
 
 -------
 
-DMX512 decoder 24channel color - Dip Switch positions = start channel no. ... (for daisy chain)
+DMX512 decoder 24channel color - Dip Switch positions = start channel no. ... (for daisy chain)  
 
 (dip switch positions)  ( <-- binary. ** Right to Left for dipsw positions)
  - board#1:  1-24 | all 'off' (0)         | 0