Skip to content

Commit

Permalink
added description in readme.md (#2)
Browse files Browse the repository at this point in the history
Added description first letter variable names will always be used (in captital)
  • Loading branch information
blb4github authored Feb 19, 2024
1 parent 1a7c1ce commit 761f16e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ python3 -m pip install heishamon_rules_minify
Start by creating a ruleset that adheres to the HeishaMon rules syntax, but can use the following extras:

- Single line comments starting with `--` or block comments between `--[[` and `]]`.
- Custom function and variable names will be minified to only keep the capital letters, so for example `#WaterTemperature` will become `#WT`.
- Custom function and variable names will be minified to only keep the first letter (which will be capitalised) and capital letters, so for example `#WaterTemperature` will become `#WT`, `#allowDHW` will become `#ADHW`.

When the ruleset is finished, minify it using the following command:

Expand Down

0 comments on commit 761f16e

Please sign in to comment.