Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

issue #478 improved README file #479

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

issue #478 improved README file #479

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ ioBroker dev-server is a simple command line tool running on Windows, Linux and

**Note:** dev-server requires at least Node.js 14.

Instead of manually editing the package.json file, users should simply run ```npm install``` to automatically install the dependencies listed in the package.json
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is common sense for NodeJS developers. I wouldn't put this in the general section of this tool.

running this command saves time and reduces errors compared to adding dependencies manually.

## Installation

```bash
Expand All @@ -18,6 +21,7 @@ dev-server watch

**Note for windows users:**
If dev-server command is not found, check that the npm directory (typically ;C:\Users\%username%\AppData\Roaming\npm) is included into the PATH variable
Users should run ```npm run dev-server``` rather than just ```dev-server```, as the latter may not work directly on Linux systems without additional setup (such as adding it to the PATH).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Combined with the remainder of the readme, this is confusing. npm run dev-server only works if it was added as a devDependency. If we want to keep this sentence, it should be moved to the dev-dependency section.


## Features

Expand Down