From 7a32af77aa161a3f09a6504f778edf2631afd944 Mon Sep 17 00:00:00 2001 From: April Date: Mon, 17 Oct 2022 21:54:02 -0700 Subject: [PATCH] Basic README --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index e69de29..880e127 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,15 @@ +# i2RecordCollector +This software handles data collection and processing for The Weather Channel's IntelliStar 2 software using a mix of TWC's v1, v2, and v3 APIs. + +# Requirements +* Firewall on the stock I2 image fixed to allow incoming connections from ``224.1.1.77`` on ports ``7787`` and ``7788`` +* [Python 3.8.0](https://www.python.org/downloads/release/python-380/) + +# Usage instructions +[Download a release](https://github.com/the5dcrew/i2MessageEncoder-Rewrite/releases) for the most stable version, or clone the repository. + +``git clone https://github.com/the5dcrew/i2MessageEncoder-Rewrite`` + +*(If downloading this as a zip, extract to the directory of your choosing.)* + +Drop your IntelliStar 2's ``MachineProductCfg.xml`` file into the root of the directory of the encoder, then run ``main.py``. \ No newline at end of file