From 031b65335c1f6c58b63a48a7d17c0c8a9e41ba7d Mon Sep 17 00:00:00 2001 From: Alex Van Camp Date: Mon, 14 Jan 2019 20:05:39 -0600 Subject: [PATCH] docs(README): mention that the program auto-discovers the matricies now --- README.md | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 1aae241..d36a1af 100644 --- a/README.md +++ b/README.md @@ -26,17 +26,9 @@ ## Usage - Connect your computer to both matrices via serial. -- Configure the program to use your serial ports. You can use environment variables, command line arguments, or a `config.json` (in the root dir of the app) to configure this program. +- (Optional) Configure the program using environment variables, command line arguments, or a `config.json` (in the root dir of the app). - [See the available config parameters here](https://github.com/GamesDoneQuick/matrix-controller/blob/master/src/config.ts). - - Example JSON config: - - ```json - { - "hdmiSerialPath": "COM1", - "componentSerialPath": "COM5" - } - ``` -- Run the program: +- Run the program (it will automatically discover the matricies if they are connected): ```bash npm start