Skip to content

Commit

Permalink
docs(README): mention that the program auto-discovers the matricies now
Browse files Browse the repository at this point in the history
  • Loading branch information
Alex Van Camp authored Jan 15, 2019
1 parent 0136995 commit 031b653
Showing 1 changed file with 2 additions and 10 deletions.
12 changes: 2 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 031b653

Please sign in to comment.