issue #478 improved README file #479
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
UncleSamSwiss
requested changes
Jan 24, 2025
| @@ -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 | |||
There was a problem hiding this comment.
This is common sense for NodeJS developers. I wouldn't put this in the general section of this tool.
| @@ -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). | |||
There was a problem hiding this comment.
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.