Use Jinja and a YAML config file to generate the required files

.gitignore

@@ -0,0 +1,2 @@
+config.yaml
+output/

CHANGELOG.md

@@ -0,0 +1,13 @@
+06-Feb-23 | Andy Symons | First posted on the community forum
+
+08-Feb-23 | Andy Symons | Improved robustness when sensors become unavailable. Posted on GitHub.
+
+12-Feb-23 | Andy Symons | Improved logic when first starting with idle timers
+
+15-Feb-23 | Andy Symons | Mode changed to queued so all triggers used but without conficting states.
+
+19-Feb-23 | Andy Symons | Continual refresh; robust through restart, all day events, and overlappng events.
+
+20-Feb-23 | Andy Symons | More verbose 'reason' text with event details where applicable (needs 255 character helper).
+
+25-Feb-23 | Andy Symons | Robust against absent or invalid tempterature specification in an event. Reports errors in the reason text.

README.md

@@ -1,11 +1,13 @@
-# Heating-X-code-generator
+# HeatingX
 
-Use Microsoft Mail Merge to create YAML files for all the template sensors and helpers required for a complete home installation of Heating X zones. 
-Microsoft Office (WORD and EXCEL) is a prerequisite (sorry I could not find a free package to do this) 
+Use Jinja to create YAML files for all the template sensors and helpers required for a complete home installation of HeatingX zones.
 
-To get started: 
-1. Download the ZIP file to a temporary location on a local disk drive. Problems can occur if it is used on a drive that is synchronised to a cloud service, such as iCloud or OneDrive (but you can keep a copy of the ZIP file if you wish). 
-2. Unzip it. 
-3. In the resulting folder there are detailed instructions in $README on how to use the Code Generator to generate and install all the YAML code you need for even the most conplex installation. 
-
-Basically you enter the details of your installation (zones and thermostats) in the EXCEL file, then use each of the five WORD files to generate the contents of a YAML file. They each generate a whole file except the dashboard card generator, which has to be installed one card at a time.    
+To get started:
+1. Make sure you have Python 3 installed.
+2. Create a virtual environment with `python3 -m venv .venv`.
+3. Activate your virtual environment with `source .venv/bin/activate`.
+4. Install the required dependencies with `python3 -m pip install requirements.txt`.
+5. Make your own `config.yaml` with `cp config.yaml.sample config.yaml`.
+6. Edit the contents of the resulting `config.yaml` to match your own installation (zones and thermostats).
+7. Create the required files with `python generate.py` which will output the files into
+the `output/` directory.