Skip to content

Commit 2495a91

Browse files
committed
Readme updated according to installation on all systems and .gitignore modiefied for excluding .DS_Store files
1 parent be0d948 commit 2495a91

File tree

2 files changed

+22
-2
lines changed

2 files changed

+22
-2
lines changed

.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,6 @@ node_modules/
33
iobroker-data/
44
.devserver/
55
.idea
6+
7+
#excluse .DS_Store files
8+
.DS_Store

README.md

+19-2
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,30 @@ You need to install the `dev-server` package as well as set it up it in the adap
3838

3939
### Install package
4040

41-
You can either install this tool as a global tool or install it as a dev-dependency of your adapter. We suggest to install it globally:
41+
<span style="color:red">*Before installing please check the following what is the best way or recommended:*</span>
42+
43+
44+
:one: Linux
45+
46+
:small_blue_diamond: install it as a dev-dependency of your adapter (recommended)
47+
:small_blue_diamond: install this tool as a global tool
48+
49+
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
50+
51+
:two: MacOS
52+
53+
:small_blue_diamond: Under MacOS be careful with installation as global. This is not recommended so better to install it as dev-depency
54+
55+
:three: Windows
56+
57+
:small_blue_diamond: Under Windows a global install is no problem.
58+
4259

4360
```bash
4461
npm install --global @iobroker/dev-server
4562
```
4663

47-
Alternatively, 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.
64+
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.
4865

4966
```json
5067
{

0 commit comments

Comments
 (0)