Skip to content

Commit 38d9f8d

Browse files
Use GitHub markdown notes
1 parent bf5d74e commit 38d9f8d

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

README.md

+15-9
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55

66
ioBroker dev-server is a simple command line tool running on Windows, Linux and macOS that allows you to quickly develop and test ioBroker adapters and their admin interface.
77

8-
**Note:** dev-server requires at least Node.js 14.
8+
> [!NOTE]
9+
> dev-server requires at least Node.js 14.
910
1011
## Installation
1112

@@ -16,8 +17,8 @@ dev-server watch
1617
```
1718
(a local installation as dev-dependency is also possible)
1819

19-
**Note for Windows users:**
20-
If dev-server command is not found, check that the npm directory (typically `C:\Users\%username%\AppData\Roaming\npm`) is included in the `PATH` variable.
20+
> [!TIP]
21+
> If the `dev-server` command is not found **under Windows**, check that the npm directory (typically `C:\Users\%username%\AppData\Roaming\npm`) is included in the `PATH` variable.
2122
2223
## Features
2324

@@ -45,27 +46,30 @@ You need to install the `dev-server` package as well as set it up it in the adap
4546
*Before installing, please check the following what is the best way or recommended:*
4647

4748

48-
1. Linux
49+
#### Linux
4950
* install it as a dev-dependency of your adapter (recommended)
5051
* install this tool as a global tool
5152

5253
Under Linux, it is sometimes useful to install this tool as global, BUT best practice for developing an own adapter it is better to install it as dev-dependency
5354

54-
2. MacOS
55+
#### MacOS
5556
* Under macOS, be careful with installation as global. This is not recommended so better to install it as a dev-dependency
5657

57-
3. Windows
58+
#### Windows
5859

5960
* Under Windows, a global installation is no problem.
6061

61-
**Note:** dev-server requires at least Node.js 14.
62+
> [!NOTE]
63+
> dev-server requires at least Node.js 14.
6264
6365
How to install it globally:
6466

6567
```bash
6668
npm install --global @iobroker/dev-server
6769
```
6870

71+
#### Installation as a development dependency
72+
6973
Some more explanation, especially when a **global installation** is problematic **because of permission** issues (e.g., on **macOS**), you can add the dev-server to your adapter's `devDependencies` and add it e.g., as a script to your package.json.
7074

7175
```json
@@ -91,7 +95,8 @@ dev-server setup
9195

9296
For additional command line arguments, see below.
9397

94-
_Note:_ the executable can either be called with the short name `dev-server` or its full name `iobroker-dev-server`. We will use the first way in this document.
98+
> [!NOTE]
99+
> The executable can either be called with the short name `dev-server` or its full name `iobroker-dev-server`. We will use the first way in this document.
95100
96101
### Exclude temporary folder
97102

@@ -159,7 +164,8 @@ Run dev-server and start the adapter in "watch" mode.
159164

160165
The adapter will automatically restart when its source code changes (with a 2-seconds delay).
161166

162-
**DO NOT** start the adapter manually in `ioBroker.admin`! If you see errors like `ADAPTER_ALREADY_RUNNING` then most likely you ignored this info :-)
167+
> [!IMPORTANT]
168+
> **DO NOT** start the adapter manually in `ioBroker.admin`! If you see errors like `ADAPTER_ALREADY_RUNNING` then most likely you ignored this info :-)
163169
164170
You may attach a debugger to the running adapter. Keep in mind that the debugger will be detached when you change your source code, you need to manually attach again to the new process. Watch the console output for the correct process id to attach to.
165171

0 commit comments

Comments
 (0)