Skip to content

Commit 5ed8f5c

Browse files
committed
ADD: Build instructions
1 parent 1a5059c commit 5ed8f5c

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,44 @@
11
# StageLinq
22
NodeJS implementation of the Denon StageLinq protocol
3+
4+
## About
5+
6+
This is a WIP demo that tries to find a Denon Stagelinq device (e.g., Prime4, Prime2 and Prime Go) on the local network, connects with it and outputs all input a user makes.
7+
8+
## Prerequisites
9+
10+
Ensure typescript is installed, if not run the following
11+
12+
```bash
13+
npm install -g typescript
14+
```
15+
16+
## Install NPM Modules
17+
18+
To fetch all required NPM modules, run the following command from the terminal
19+
20+
```bash
21+
npm install
22+
```
23+
24+
## Build & Run
25+
26+
### Visual Studio Code
27+
28+
* Load `stagelinq.code-workspace` in VS Code
29+
* Run `launch` from the debug tab
30+
31+
### Command line Build
32+
33+
```bash
34+
tsc --build tsconfig.json
35+
```
36+
37+
### Command line Run
38+
39+
```bash
40+
node ./dist/main.js
41+
```
42+
43+
44+

0 commit comments

Comments
 (0)